uiMultilineEntry Struct Reference

Description

A control with a multi line text entry field.

Todo

provide a facility for entering tab stops?

#include <ui.h>

Public Member Functions
char *	uiMultilineEntryText (uiMultilineEntry *e)
	Returns the multi line entry's text.
void	uiMultilineEntrySetText (uiMultilineEntry *e, const char *text)
	Sets the multi line entry's text.
void	uiMultilineEntryAppend (uiMultilineEntry *e, const char *text)
	Appends text to the multi line entry's text.
void	uiMultilineEntryOnChanged (uiMultilineEntry *e, void(*f)(uiMultilineEntry *sender, void *senderData), void *data)
	Registers a callback for when the user changes the multi line entry's text.
int	uiMultilineEntryReadOnly (uiMultilineEntry *e)
	Returns whether or not the multi line entry's text can be changed.
void	uiMultilineEntrySetReadOnly (uiMultilineEntry *e, int readonly)
	Sets whether or not the multi line entry's text is read only.
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
uiMultilineEntry *	uiNewMultilineEntry (void)
	Creates a new multi line entry that visually wraps text when lines overflow.
uiMultilineEntry *	uiNewNonWrappingMultilineEntry (void)
	Creates a new multi line entry that scrolls horizontally when lines overflow.
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

uiMultilineEntryAppend()

void uiMultilineEntryAppend	(	uiMultilineEntry *	e,
		const char *	text )

Appends text to the multi line entry's text.

Parameters

e	uiMultilineEntry instance.
text	Text to append. A valid, NUL terminated UTF-8 string. Data is copied internally. Ownership is not transferred.

uiMultilineEntryOnChanged()

void uiMultilineEntryOnChanged	(	uiMultilineEntry *	e,
		void(*	f )(uiMultilineEntry *sender, void *senderData),
		void *	data )

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

Parameters

e	uiMultilineEntry 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 uiMultilineEntrySetText() or uiMultilineEntryAppend().

Only one callback can be registered at a time.

uiMultilineEntryReadOnly()

int uiMultilineEntryReadOnly

(

uiMultilineEntry *

e

)

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

Parameters

e	uiMultilineEntry instance.

Returns

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

uiMultilineEntrySetReadOnly()

void uiMultilineEntrySetReadOnly	(	uiMultilineEntry *	e,
		int	readonly )

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

Parameters

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

uiMultilineEntrySetText()

void uiMultilineEntrySetText	(	uiMultilineEntry *	e,
		const char *	text )

Sets the multi line entry's text.

Parameters

e	uiMultilineEntry instance.
text	Single/multi line text. A valid, NUL terminated UTF-8 string. Data is copied internally. Ownership is not transferred.

uiMultilineEntryText()

char * uiMultilineEntryText

(

uiMultilineEntry *

e

)

Returns the multi line entry's text.

Parameters

e	uiMultilineEntry instance.

Returns

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

uiNewMultilineEntry()

uiMultilineEntry * uiNewMultilineEntry ( void )

static

Creates a new multi line entry that visually wraps text when lines overflow.

Returns

A new uiMultilineEntry instance.

uiNewNonWrappingMultilineEntry()

uiMultilineEntry * uiNewNonWrappingMultilineEntry ( void )

static

Creates a new multi line entry that scrolls horizontally when lines overflow.

Remarks

Windows does not allow for this style to be changed after creation, hence the two constructors.

Returns

A new uiMultilineEntry instance.

---

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

• include/ui.h