wx.DateTime.NameForm

Class representing a name form.

This class describes the form of month or weekday names used in formatting a date. It contains attributes for the requested name length and the formatting context. It is used as a parameter to the GetWeekDayName and GetMonthName functions.

Added in version 4.3/wxWidgets-3.3.0.

Class Hierarchy

Inheritance diagram for class NameForm:

Methods Summary

__init__	Constructor for a name form.
Abbr	Set the flag for abbreviated month or weekday names.
Formatting	Set the context for date formatting.
Full	Set the flag for full month or weekday names.
GetContext	Return the context of name usage.
GetFlags	Return the flags describing the requested name length.
Shortest	Set the flag for shortest month or weekday names.
Standalone	Set the context for standalone use.

Properties Summary

Context	See GetContext
Flags	See GetFlags

Class API

class wx.DateTime.NameForm(object)

Possible constructors:

NameForm(flags=DateTime.NameFlags.Name_Full) -> None

Class representing a name form.

Methods

__init__(self, flags=DateTime.NameFlags.Name_Full)

Constructor for a name form.

Initializes this object to use the given form of the name (full by default) in the formatting context.

Note that this constructor is not explicit, to allow the existing code which passes wx.DateTime.NameFlags to various functions now taking wx.DateTime.NameForm to work. Please beware of the implicit conversions here.

Parameters:

flags (DateTime.NameFlags)

Return type:

None

---

Abbr(self)

Set the flag for abbreviated month or weekday names.

Return type:

wx.DateTime.NameForm

---

Formatting(self)

Set the context for date formatting.

In some languages, month and day names have different forms depending on whether they’re used on their own, e.g. as names of the months in the calendar, or as part of a date representation.

Use this function if you need to localize a date format or in another similar context.

Return type:

wx.DateTime.NameForm

See also

Standalone

---

Full(self)

Set the flag for full month or weekday names.

Return type:

wx.DateTime.NameForm

---

GetContext(self)

Return the context of name usage.

Return type:

wx.DateTime.NameContext

---

GetFlags(self)

Return the flags describing the requested name length.

Return type:

wx.DateTime.NameFlags

---

Shortest(self)

Set the flag for shortest month or weekday names.

Return type:

wx.DateTime.NameForm

---

Standalone(self)

Set the context for standalone use.

Return type:

wx.DateTime.NameForm

Properties

Context

See GetContext

---

Flags

See GetFlags