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

A control to enter a date and/or time. More...

#include <ui.h>

Inheritance diagram for uiDateTimePicker:
uiControl

Public Member Functions

void uiDateTimePickerTime (uiDateTimePicker *d, struct tm *time)
 Returns date and time stored in the data time picker. More...
 
void uiDateTimePickerSetTime (uiDateTimePicker *d, const struct tm *time)
 Sets date and time of the data time picker. More...
 
void uiDateTimePickerOnChanged (uiDateTimePicker *d, void(*f)(uiDateTimePicker *sender, void *senderData), void *data)
 Registers a callback for when the date time picker value is changed by the user. More...
 
uiDateTimePickeruiNewDateTimePicker (void)
 Creates a new date picker. More...
 
uiDateTimePickeruiNewDatePicker (void)
 Creates a new time picker. More...
 
uiDateTimePickeruiNewTimePicker (void)
 Creates a new date and time picker. 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 to enter a date and/or time.

All functions operate on struct tm as defined in <time.h>.

All functions assume local time and do NOT perform any time zone conversions.

Warning
The struct tm members tm_wday and tm_yday are undefined.
The struct tm member tm_isdst is ignored on windows and should be set to -1.
Todo:
for Time: define what values are returned when a part is missing

Member Function Documentation

◆ uiDateTimePickerOnChanged()

void uiDateTimePickerOnChanged ( uiDateTimePicker d,
void(*)(uiDateTimePicker *sender, void *senderData)  f,
void *  data 
)

Registers a callback for when the date time picker value is changed by the user.

Parameters
duiDateTimePicker 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 uiDateTimePickerSetTime().
Only one callback can be registered at a time.

◆ uiDateTimePickerSetTime()

void uiDateTimePickerSetTime ( uiDateTimePicker d,
const struct tm *  time 
)

Sets date and time of the data time picker.

Parameters
duiDateTimePicker instance.
timeDate and/or time as local time.
Warning
The struct tm member tm_isdst is ignored on windows and should be set to -1.

◆ uiDateTimePickerTime()

void uiDateTimePickerTime ( uiDateTimePicker d,
struct tm *  time 
)

Returns date and time stored in the data time picker.

Parameters
duiDateTimePicker instance.
[out]timeDate and/or time as local time.
Warning
The struct tm members tm_wday and tm_yday are undefined.

◆ uiNewDatePicker()

uiDateTimePicker * uiNewDatePicker ( void  )

Creates a new time picker.

Returns
A new uiDateTimePicker instance.

◆ uiNewDateTimePicker()

uiDateTimePicker * uiNewDateTimePicker ( void  )

Creates a new date picker.

Returns
A new uiDateTimePicker instance.

◆ uiNewTimePicker()

uiDateTimePicker * uiNewTimePicker ( void  )

Creates a new date and time picker.

Returns
A new uiDateTimePicker instance.

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