entry.h File Reference

Entry Widget. More...

#include "ntw.h"

Go to the source code of this file.

Functions

char * ntw_entry_get_text (ntwWidget *widget)
 Get the current text of an entry widget.
int ntw_entry_set_text (ntwWidget *widget, char *text)
 Set the current text of an entry widget.
uint8 ntw_entry_get_editable (ntwWidget *widget)
 Get entry editability.
int ntw_entry_set_editable (ntwWidget *widget, uint8 editable)
 Set entry editability.
int32 ntw_entry_get_max_length (ntwWidget *widget)
 Get entry maximum length.
int ntw_entry_set_max_length (ntwWidget *widget, int32 max_length)
 Set entry maximum length.
uint8 ntw_entry_get_visibility (ntwWidget *widget)
 Get entry visibility.
int ntw_entry_set_visibility (ntwWidget *widget, uint8 visibility)
 Set entry visibility.
ntwWidget * ntw_entry_new ()
 Create entry.
void ntw_entry_initialize_callback ()


Detailed Description

Entry Widget.

An entry widget allows the user to enter single-line text in UTF-8 encoding. The text can be hidden, as in a password field.


Function Documentation

uint8 ntw_entry_get_editable ntwWidget *  widget  ) 
 

Get entry editability.

Get the status of the entry editable flag.

Parameters:
widget entry widget
Returns:
TRUE if editable, FALSE if not

int32 ntw_entry_get_max_length ntwWidget *  widget  ) 
 

Get entry maximum length.

Get the bounds on the number of characters that may be typed in an entry widget. 0 means no limit.

Parameters:
widget entry widget
Returns:
Maximum length in characters.

char* ntw_entry_get_text ntwWidget *  widget  ) 
 

Get the current text of an entry widget.

Parameters:
widget entry widget
Returns:
Text string

uint8 ntw_entry_get_visibility ntwWidget *  widget  ) 
 

Get entry visibility.

The visibility refers to whether or not the typed characters are echoed to the screen. If FALSE, the characters will be replaced by asterisks, as in a password field. Default is TRUE.

Parameters:
widget entry widget
Returns:
TRUE if characters will be visible, FALSE if characters will be hidden.

ntwWidget* ntw_entry_new  ) 
 

Create entry.

Returns:
Newly created entry

int ntw_entry_set_editable ntwWidget *  widget,
uint8  editable
 

Set entry editability.

Set the ability of a user to change the text in an entry. TRUE is editable, FALSE is non-editable. Default is TRUE.

Parameters:
widget entry widget
editable TRUE for editable, FALSE otherwise
Returns:
-1 on failure

int ntw_entry_set_max_length ntwWidget *  widget,
int32  max_length
 

Set entry maximum length.

Set the bounds on the number of characters that may be typed in an entry widget. 0 means no limit.

Parameters:
widget entry widget
max_length Maximum length in characters
Returns:
-1 on failure

int ntw_entry_set_text ntwWidget *  widget,
char *  text
 

Set the current text of an entry widget.

Note that this is destructive, none of the old text will remain. Text string should be in UTF-8 format (ASCII text is valid UTF-8).

Parameters:
widget entry widget
text Text string to set
Returns:
-1 on failure

int ntw_entry_set_visibility ntwWidget *  widget,
uint8  visibility
 

Set entry visibility.

The visibility refers to whether or not the typed characters are echoed to the screen. If FALSE, the characters will be replaced by asterisks, as in a password field. Default is TRUE.

Parameters:
widget entry widget
visibility TRUE or FALSE
Returns:
-1 on failure


Generated on Wed Jun 28 17:00:07 2006 for NTW Server C Library by  doxygen 1.4.6