uiEntry Struct Reference

Description

A control with a single line text entry field.

#include <ui.h>

Public Member Functions
char *	uiEntryText (uiEntry *e)
	Returns the entry's text.
void	uiEntrySetText (uiEntry *e, const char *text)
	Sets the entry's text.
void	uiEntryOnChanged (uiEntry *e, void(*f)(uiEntry *sender, void *senderData), void *data)
	Registers a callback for when the user changes the entry's text.
int	uiEntryReadOnly (uiEntry *e)
	Returns whether or not the entry's text can be changed.
void	uiEntrySetReadOnly (uiEntry *e, int readonly)
	Sets whether or not the entry's text is read only.
char *	uiEntryPlaceholder (uiEntry *e)
	Returns the entry's placeholder.
void	uiEntrySetPlaceholder (uiEntry *e, const char *text)
	Sets text to be displayed in the entry when it is empty.
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
uiEntry *	uiNewEntry (void)
	Creates a new entry.
uiEntry *	uiNewPasswordEntry (void)
	Creates a new entry suitable for sensitive inputs like passwords.
uiEntry *	uiNewSearchEntry (void)
	Creates a new entry suitable for search.
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

uiEntryOnChanged()

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

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

Parameters

e	uiEntry instance.
f	Callback function. sender Back reference to the instance that initiated 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 uiEntrySetText().

uiEntryPlaceholder()

char * uiEntryPlaceholder

(

uiEntry *

e

)

Returns the entry's placeholder.

Parameters

e	uiEntry instance.

Returns

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

uiEntryReadOnly()

int uiEntryReadOnly

(

uiEntry *

e

)

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

Parameters

e	uiEntry instance.

Returns

TRUE if read only, FALSE otherwise. [Default: FALSE]

uiEntrySetPlaceholder()

void uiEntrySetPlaceholder	(	uiEntry *	e,
		const char *	text )

Sets text to be displayed in the entry when it is empty.

Parameters

e	uiEntry instance.
text	Placeholder text. A valid, NUL terminated UTF-8 string. Data is copied internally. Ownership is not transferred.

Warning

Read only entries do not display the placeholder text on Windows.

uiEntrySetReadOnly()

void uiEntrySetReadOnly	(	uiEntry *	e,
		int	readonly )

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

Parameters

e	uiEntry instance.
readonly	TRUE to make read only, FALSE otherwise.

uiEntrySetText()

void uiEntrySetText	(	uiEntry *	e,
		const char *	text )

Sets the entry's text.

Parameters

e	uiEntry instance.
text	Entry 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

e	uiEntry 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 )

static

Creates a new entry.

Returns

A new uiEntry instance.

uiNewPasswordEntry()

uiEntry * uiNewPasswordEntry ( void )

static

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 )

static

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:

• include/ui.h