uiColorButton Struct Reference

Description

A control with a color indicator that opens a color chooser when clicked.

The control visually represents a button with a color field representing the selected color.

Clicking on the button opens up a color chooser in form of a color palette.

#include <ui.h>

Public Member Functions
void	uiColorButtonColor (uiColorButton *b, double *r, double *g, double *bl, double *a)
	Returns the color button color.
void	uiColorButtonSetColor (uiColorButton *b, double r, double g, double bl, double a)
	Sets the color button color.
void	uiColorButtonOnChanged (uiColorButton *b, void(*f)(uiColorButton *sender, void *senderData), void *data)
	Registers a callback for when the color is changed.
Public Member Functions inherited from uiControl
void	uiControlDestroy (uiControl *c)
	Dispose and free all allocated resources.
uintptr_t	uiControlHandle (uiControl *c)
	Returns the control's OS-level handle.
uiControl *	uiControlParent (uiControl *c)
	Returns the parent control.
void	uiControlSetParent (uiControl *c, uiControl *parent)
	Sets the control's parent.
int	uiControlToplevel (uiControl *c)
	Returns whether or not the control is a top level control.
int	uiControlVisible (uiControl *c)
	Returns whether or not the control is visible.
void	uiControlShow (uiControl *c)
	Shows the control.
void	uiControlHide (uiControl *c)
	Hides the control.
int	uiControlEnabled (uiControl *c)
	Returns whether or not the control is enabled.
void	uiControlEnable (uiControl *c)
	Enables the control.
void	uiControlDisable (uiControl *c)
	Disables the control.
void	uiFreeControl (uiControl *c)
	Frees the memory associated with the control reference.
void	uiControlVerifySetParent (uiControl *c, uiControl *parent)
	Makes sure the control's parent can be set to parent.
int	uiControlEnabledToUser (uiControl *c)
	Returns whether or not the control can be interacted with by the user.
void	uiControlSetTooltip (uiControl *c, const char *tooltip)
	Sets the control tooltip.

Static Public Member Functions
uiColorButton *	uiNewColorButton (void)
	Creates a new color button.
Static Public Member Functions inherited from uiControl
uiControl *	uiAllocControl (size_t n, uint32_t OSsig, uint32_t typesig, const char *typenamestr)
	Allocates a uiControl.

Additional Inherited Members
Public Attributes inherited from uiControl
uint32_t	Signature
uint32_t	OSSignature
uint32_t	TypeSignature
void(*	Destroy )(uiControl *)
uintptr_t(*	Handle )(uiControl *)
uiControl *(*	Parent )(uiControl *)
void(*	SetParent )(uiControl *, uiControl *)
int(*	Toplevel )(uiControl *)
int(*	Visible )(uiControl *)
void(*	Show )(uiControl *)
void(*	Hide )(uiControl *)
int(*	Enabled )(uiControl *)
void(*	Enable )(uiControl *)
void(*	Disable )(uiControl *)

Member Function Documentation

uiColorButtonColor()

void uiColorButtonColor	(	uiColorButton *	b,
		double *	r,
		double *	g,
		double *	bl,
		double *	a )

Returns the color button color.

Parameters

	b	uiColorButton instance.
[out]	r	Red. Double in range of [0, 1.0].
[out]	g	Green. Double in range of [0, 1.0].
[out]	bl	Blue. Double in range of [0, 1.0].
[out]	a	Alpha. Double in range of [0, 1.0].

uiColorButtonOnChanged()

void uiColorButtonOnChanged	(	uiColorButton *	b,
		void(*	f )(uiColorButton *sender, void *senderData),
		void *	data )

Registers a callback for when the color is changed.

Parameters

b	uiColorButton instance.
f	Callback function. sender Back reference to the instance that triggered the callback. senderData User data registered with the sender instance.
data	User data to be passed to the callback.

Note

The callback is not triggered when calling uiColorButtonSetColor().

Only one callback can be registered at a time.

uiColorButtonSetColor()

void uiColorButtonSetColor	(	uiColorButton *	b,
		double	r,
		double	g,
		double	bl,
		double	a )

Sets the color button color.

Parameters

b	uiColorButton instance.
r	Red. Double in range of [0, 1.0].
g	Green. Double in range of [0, 1.0].
bl	Blue. Double in range of [0, 1.0].
a	Alpha. Double in range of [0, 1.0].

uiNewColorButton()

uiColorButton * uiNewColorButton ( void )

static

Creates a new color button.

Returns

A new uiColorButton instance.

---

The documentation for this struct was generated from the following file:

• include/ui.h