libui-ng
A portable GUI library for C
uiColorButton Struct Reference

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

#include <ui.h>

Inheritance diagram for uiColorButton:
uiControl

Public Member Functions

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

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 *)
 

Detailed 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.

Member Function Documentation

◆ uiColorButtonColor()

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

Returns the color button color.

Parameters
buiColorButton instance.
[out]rRed. Double in range of [0, 1.0].
[out]gGreen. Double in range of [0, 1.0].
[out]blBlue. Double in range of [0, 1.0].
[out]aAlpha. Double in range of [0, 1.0].

◆ uiColorButtonOnChanged()

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

Registers a callback for when the color is changed.

Parameters
buiColorButton instance.
fCallback function.
sender Back reference to the instance that triggered the callback.
senderData User data registered with the sender instance.
dataUser 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
buiColorButton instance.
rRed. Double in range of [0, 1.0].
gGreen. Double in range of [0, 1.0].
blBlue. Double in range of [0, 1.0].
aAlpha. Double in range of [0, 1.0].

◆ uiNewColorButton()

uiColorButton * uiNewColorButton ( void  )

Creates a new color button.

Returns
A new uiColorButton instance.

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