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

A control with a single line text entry field. More...

#include <ui.h>

Inheritance diagram for uiEntry:
uiControl

Public Member Functions

char * uiEntryText (uiEntry *e)
 Returns the entry's text. More...
 
void uiEntrySetText (uiEntry *e, const char *text)
 Sets the entry's text. More...
 
void uiEntryOnChanged (uiEntry *e, void(*f)(uiEntry *sender, void *senderData), void *data)
 Registers a callback for when the user changes the entry's text. More...
 
int uiEntryReadOnly (uiEntry *e)
 Returns whether or not the entry's text can be changed. More...
 
void uiEntrySetReadOnly (uiEntry *e, int readonly)
 Sets whether or not the entry's text is read only. More...
 
uiEntryuiNewEntry (void)
 Creates a new entry. More...
 
uiEntryuiNewPasswordEntry (void)
 Creates a new entry suitable for sensitive inputs like passwords. More...
 
uiEntryuiNewSearchEntry (void)
 Creates a new entry suitable for search. 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 single line text entry field.

Member Function Documentation

◆ uiEntryOnChanged()

void uiEntryOnChanged ( uiEntry e,
void(*)(uiEntry *sender, void *senderData)  f,
void *  data 
)

Registers a callback for when the user changes the entry's text.

Parameters
euiEntry instance.
fCallback function.
sender Back reference to the instance that initiated 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 uiEntrySetText().

◆ uiEntryReadOnly()

int uiEntryReadOnly ( uiEntry e)

Returns whether or not the entry's text can be changed.

Parameters
euiEntry instance.
Returns
TRUE if read only, FALSE otherwise. [Default: FALSE]

◆ uiEntrySetReadOnly()

void uiEntrySetReadOnly ( uiEntry e,
int  readonly 
)

Sets whether or not the entry's text is read only.

Parameters
euiEntry instance.
readonlyTRUE to make read only, FALSE otherwise.

◆ uiEntrySetText()

void uiEntrySetText ( uiEntry e,
const char *  text 
)

Sets the entry's text.

Parameters
euiEntry instance.
textEntry text.
A valid, NUL terminated UTF-8 string.
Data is copied internally. Ownership is not transferred.

◆ uiEntryText()

char * uiEntryText ( uiEntry e)

Returns the entry's text.

Parameters
euiEntry instance.
Returns
The text of the entry.
A NUL terminated UTF-8 string.
Caller is responsible for freeing the data with uiFreeText().

◆ uiNewEntry()

uiEntry * uiNewEntry ( void  )

Creates a new entry.

Returns
A new uiEntry instance.

◆ uiNewPasswordEntry()

uiEntry * uiNewPasswordEntry ( void  )

Creates a new entry suitable for sensitive inputs like passwords.

The entered text is NOT readable by the user but masked as *******.

Returns
A new uiEntry instance.

◆ uiNewSearchEntry()

uiEntry * uiNewSearchEntry ( void  )

Creates a new entry suitable for search.

Some systems will deliberately delay the uiEntryOnChanged() callback for a more natural feel.

Returns
A new uiEntry instance.

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