.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.NativeFontInfo:
==========================================================================================================================================
|phoenix_title| **wx.NativeFontInfo**
==========================================================================================================================================
:ref:`wx.NativeFontInfo` is platform-specific font representation: this class should be considered as an opaque font description only used by the native functions, the user code can only get the objects of this type from somewhere and pass it somewhere else (possibly save them somewhere using `wx.ToString` and restore them using `wx.FromString` )
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
NativeFontInfo:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.NativeFontInfo.__init__`
:meth:`~wx.NativeFontInfo.FromString`
:meth:`~wx.NativeFontInfo.FromUserString`
:meth:`~wx.NativeFontInfo.GetEncoding`
:meth:`~wx.NativeFontInfo.GetFaceName`
:meth:`~wx.NativeFontInfo.GetFamily`
:meth:`~wx.NativeFontInfo.GetFractionalPointSize`
:meth:`~wx.NativeFontInfo.GetNumericWeight`
:meth:`~wx.NativeFontInfo.GetPointSize`
:meth:`~wx.NativeFontInfo.GetStyle`
:meth:`~wx.NativeFontInfo.GetUnderlined`
:meth:`~wx.NativeFontInfo.GetWeight`
:meth:`~wx.NativeFontInfo.Init`
:meth:`~wx.NativeFontInfo.InitFromFont`
:meth:`~wx.NativeFontInfo.SetEncoding`
:meth:`~wx.NativeFontInfo.SetFaceName`
:meth:`~wx.NativeFontInfo.SetFamily`
:meth:`~wx.NativeFontInfo.SetFractionalPointSize`
:meth:`~wx.NativeFontInfo.SetNumericWeight`
:meth:`~wx.NativeFontInfo.SetPointSize`
:meth:`~wx.NativeFontInfo.SetStyle`
:meth:`~wx.NativeFontInfo.SetUnderlined`
:meth:`~wx.NativeFontInfo.SetWeight`
:meth:`~wx.NativeFontInfo.ToString`
:meth:`~wx.NativeFontInfo.ToUserString`
:meth:`~wx.NativeFontInfo.__str__`
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.NativeFontInfo.Encoding` See :meth:`~wx.NativeFontInfo.GetEncoding` and :meth:`~wx.NativeFontInfo.SetEncoding`
:attr:`~wx.NativeFontInfo.FaceName` See :meth:`~wx.NativeFontInfo.GetFaceName` and :meth:`~wx.NativeFontInfo.SetFaceName`
:attr:`~wx.NativeFontInfo.Family` See :meth:`~wx.NativeFontInfo.GetFamily` and :meth:`~wx.NativeFontInfo.SetFamily`
:attr:`~wx.NativeFontInfo.FractionalPointSize` See :meth:`~wx.NativeFontInfo.GetFractionalPointSize` and :meth:`~wx.NativeFontInfo.SetFractionalPointSize`
:attr:`~wx.NativeFontInfo.NumericWeight` See :meth:`~wx.NativeFontInfo.GetNumericWeight` and :meth:`~wx.NativeFontInfo.SetNumericWeight`
:attr:`~wx.NativeFontInfo.PointSize` See :meth:`~wx.NativeFontInfo.GetPointSize` and :meth:`~wx.NativeFontInfo.SetPointSize`
:attr:`~wx.NativeFontInfo.Style` See :meth:`~wx.NativeFontInfo.GetStyle` and :meth:`~wx.NativeFontInfo.SetStyle`
:attr:`~wx.NativeFontInfo.Underlined` See :meth:`~wx.NativeFontInfo.GetUnderlined` and :meth:`~wx.NativeFontInfo.SetUnderlined`
:attr:`~wx.NativeFontInfo.Weight` See :meth:`~wx.NativeFontInfo.GetWeight` and :meth:`~wx.NativeFontInfo.SetWeight`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.NativeFontInfo(object)
**Possible constructors**::
NativeFontInfo() -> None
NativeFontInfo(info : NativeFontInfo) -> None
NativeFontInfo is platform-specific font representation: this class
should be considered as an opaque font description only used by the
native functions, the user code can only get the objects of this type
from somewhere and pass it somewhere else (possibly save them
somewhere using ToString() and restore them using FromString())
.. method:: __init__(self, *args, **kw)
|overload| **Overloaded Implementations:**
:html:`
`
**__init__** `(self)`
:rtype: `None`
:html:`
`
**__init__** `(self, info : NativeFontInfo)`
:param `info`:
:type `info`: wx.NativeFontInfo
:rtype: `None`
:html:`
`
.. method:: FromString(self, s : str)
:param `s`:
:type `s`: string
:rtype: `bool`
.. method:: FromUserString(self, s : str)
:param `s`:
:type `s`: string
:rtype: `bool`
.. method:: GetEncoding(self)
:rtype: :ref:`wx.FontEncoding`
.. method:: GetFaceName(self)
:rtype: `str`
.. method:: GetFamily(self)
:rtype: :ref:`wx.FontFamily`
.. method:: GetFractionalPointSize(self)
:rtype: `float`
.. method:: GetNumericWeight(self)
:rtype: `int`
.. method:: GetPointSize(self)
:rtype: `int`
.. method:: GetStyle(self)
:rtype: :ref:`wx.FontStyle`
.. method:: GetUnderlined(self)
:rtype: `bool`
.. method:: GetWeight(self)
:rtype: :ref:`wx.FontWeight`
.. method:: Init(self)
:rtype: `None`
.. method:: InitFromFont(self, font : Font)
:param `font`:
:type `font`: wx.Font
:rtype: `None`
.. method:: SetEncoding(self, encoding : FontEncoding)
:param `encoding`:
:type `encoding`: wx.FontEncoding
:rtype: `None`
.. method:: SetFaceName(self, *args, **kw)
|overload| **Overloaded Implementations:**
:html:`
`
**SetFaceName** `(self, facename : str)`
:param `facename`:
:type `facename`: string
:rtype: `bool`
:html:`
`
**SetFaceName** `(self, facenames : List[str])`
:param `facenames`:
:type `facenames`: list of strings
:rtype: `None`
:html:`
`
.. method:: SetFamily(self, family : FontFamily)
:param `family`:
:type `family`: wx.FontFamily
:rtype: `None`
.. method:: SetFractionalPointSize(self, pointsize : float)
:param `pointsize`:
:type `pointsize`: float
:rtype: `None`
.. method:: SetNumericWeight(self, weight : int)
:param `weight`:
:type `weight`: int
:rtype: `None`
.. method:: SetPointSize(self, pointsize : int)
:param `pointsize`:
:type `pointsize`: int
:rtype: `None`
.. method:: SetStyle(self, style : FontStyle)
:param `style`:
:type `style`: wx.FontStyle
:rtype: `None`
.. method:: SetUnderlined(self, underlined : bool)
:param `underlined`:
:type `underlined`: bool
:rtype: `None`
.. method:: SetWeight(self, weight : FontWeight)
:param `weight`:
:type `weight`: wx.FontWeight
:rtype: `None`
.. method:: ToString(self)
:rtype: `str`
.. method:: ToUserString(self)
:rtype: `str`
.. method:: __str__(self)
:rtype: `str`
.. attribute:: Encoding
See :meth:`~wx.NativeFontInfo.GetEncoding` and :meth:`~wx.NativeFontInfo.SetEncoding`
.. attribute:: FaceName
See :meth:`~wx.NativeFontInfo.GetFaceName` and :meth:`~wx.NativeFontInfo.SetFaceName`
.. attribute:: Family
See :meth:`~wx.NativeFontInfo.GetFamily` and :meth:`~wx.NativeFontInfo.SetFamily`
.. attribute:: FractionalPointSize
See :meth:`~wx.NativeFontInfo.GetFractionalPointSize` and :meth:`~wx.NativeFontInfo.SetFractionalPointSize`
.. attribute:: NumericWeight
See :meth:`~wx.NativeFontInfo.GetNumericWeight` and :meth:`~wx.NativeFontInfo.SetNumericWeight`
.. attribute:: PointSize
See :meth:`~wx.NativeFontInfo.GetPointSize` and :meth:`~wx.NativeFontInfo.SetPointSize`
.. attribute:: Style
See :meth:`~wx.NativeFontInfo.GetStyle` and :meth:`~wx.NativeFontInfo.SetStyle`
.. attribute:: Underlined
See :meth:`~wx.NativeFontInfo.GetUnderlined` and :meth:`~wx.NativeFontInfo.SetUnderlined`
.. attribute:: Weight
See :meth:`~wx.NativeFontInfo.GetWeight` and :meth:`~wx.NativeFontInfo.SetWeight`