.. 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.adv.AboutDialogInfo:

==========================================================================================================================================
|phoenix_title|  **wx.adv.AboutDialogInfo**
==========================================================================================================================================

:ref:`wx.adv.AboutDialogInfo`  contains information shown in the standard `About`  dialog displayed by the :ref:`wx.adv.AboutBox`  function.          

This class contains the general information about the program, such as its name, version, copyright and so on, as well as lists of the program developers, documentation writers, artists and translators. The simple properties from the former group are represented as a string with the exception of the program icon and the program web site, while the lists from the latter group are stored as :ref:`ArrayString`  and can be either set entirely at once using :meth:`wx.adv.AboutDialogInfo.SetDevelopers`   and similar functions or built one by one using :meth:`wx.adv.AboutDialogInfo.AddDeveloper`   etc. 

Please also notice that while all the main platforms have the native implementation of the about dialog, they are often more limited than the generic version provided by wxWidgets and so the generic version is used if :ref:`wx.adv.AboutDialogInfo`  has any fields not supported by the native version. Currently GTK+ version supports all the possible fields natively but MSW and Mac versions don't support URLs, licence text nor custom icons in the about dialog and if either of those is used, :ref:`wx.adv.AboutBox`  will automatically use the generic version so you should avoid specifying these fields to achieve more native look and feel. 

Example of usage: ::

        def OnAbout(self, event):

            aboutInfo = wx.adv.AboutDialogInfo()
            aboutInfo.SetName("MyApp")
            aboutInfo.SetVersion(MY_APP_VERSION_STRING)
            aboutInfo.SetDescription(_("My wxPython-based application!"))
            aboutInfo.SetCopyright("(C) 1992-2012")
            aboutInfo.SetWebSite("http:#myapp.org")
            aboutInfo.AddDeveloper("My Self")

            wx.adv.AboutBox(aboutInfo)









         



.. seealso:: :meth:`wx.adv.AboutDialogInfo.SetArtists`     







|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>AboutDialogInfo</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.adv.AboutDialogInfo_inheritance.png" alt="Inheritance diagram of AboutDialogInfo" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.adv.AboutDialogInfo.html" title="wx.adv.AboutDialogInfo" alt="" coords="5,5,183,35"/> </map> 
   </p>
   </div>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.adv.AboutDialogInfo.__init__`                                         Default constructor leaves all fields are initially uninitialized, in general you should call at least :meth:`~AboutDialogInfo.SetVersion` , :meth:`~AboutDialogInfo.SetCopyright`   and :meth:`~AboutDialogInfo.SetDescription` .
:meth:`~wx.adv.AboutDialogInfo.AddArtist`                                        Adds an artist name to be shown in the program credits.
:meth:`~wx.adv.AboutDialogInfo.AddDeveloper`                                     Adds a developer name to be shown in the program credits.
:meth:`~wx.adv.AboutDialogInfo.AddDocWriter`                                     Adds a documentation writer name to be shown in the program credits.
:meth:`~wx.adv.AboutDialogInfo.AddTranslator`                                    Adds a translator name to be shown in the program credits.
:meth:`~wx.adv.AboutDialogInfo.GetArtists`                                       Returns an array of the artist strings set in the dialog info.
:meth:`~wx.adv.AboutDialogInfo.GetCopyright`                                     Get the copyright string.
:meth:`~wx.adv.AboutDialogInfo.GetDescription`                                   Get the description string.
:meth:`~wx.adv.AboutDialogInfo.GetDevelopers`                                    Returns an array of the developer strings set in the dialog info.
:meth:`~wx.adv.AboutDialogInfo.GetDocWriters`                                    Returns an array of the writer strings set in the dialog info.
:meth:`~wx.adv.AboutDialogInfo.GetIcon`                                          Returns the icon set by :meth:`~AboutDialogInfo.SetIcon` .
:meth:`~wx.adv.AboutDialogInfo.GetLicence`                                       Returns the licence string.
:meth:`~wx.adv.AboutDialogInfo.GetLongVersion`                                   Return the long version string if set.
:meth:`~wx.adv.AboutDialogInfo.GetName`                                          Get the name of the program.
:meth:`~wx.adv.AboutDialogInfo.GetTranslators`                                   Returns an array of the translator strings set in the dialog info.
:meth:`~wx.adv.AboutDialogInfo.GetVersion`                                       Return the short version string.
:meth:`~wx.adv.AboutDialogInfo.GetWebSiteDescription`                            Returns the description of the website URL set for the dialog.
:meth:`~wx.adv.AboutDialogInfo.GetWebSiteURL`                                    Returns the website URL set for the dialog.
:meth:`~wx.adv.AboutDialogInfo.HasArtists`                                       Returns ``True`` if artists have been set in the dialog info.
:meth:`~wx.adv.AboutDialogInfo.HasCopyright`                                     Returns ``True`` if a copyright string has been specified.
:meth:`~wx.adv.AboutDialogInfo.HasDescription`                                   Returns ``True`` if a description string has been specified.
:meth:`~wx.adv.AboutDialogInfo.HasDevelopers`                                    Returns ``True`` if developers have been set in the dialog info.
:meth:`~wx.adv.AboutDialogInfo.HasDocWriters`                                    Returns ``True`` if writers have been set in the dialog info.
:meth:`~wx.adv.AboutDialogInfo.HasIcon`                                          Returns ``True`` if an icon has been set for the about dialog.
:meth:`~wx.adv.AboutDialogInfo.HasLicence`                                       Returns ``True`` if the licence string has been set.
:meth:`~wx.adv.AboutDialogInfo.HasTranslators`                                   Returns ``True`` if translators have been set in the dialog info.
:meth:`~wx.adv.AboutDialogInfo.HasWebSite`                                       Returns ``True`` if the website info has been set.
:meth:`~wx.adv.AboutDialogInfo.SetArtists`                                       Sets the list of artists to be shown in the program credits.
:meth:`~wx.adv.AboutDialogInfo.SetCopyright`                                     Set the short string containing the program copyright information.
:meth:`~wx.adv.AboutDialogInfo.SetDescription`                                   Set brief, but possibly multiline, description of the program.
:meth:`~wx.adv.AboutDialogInfo.SetDevelopers`                                    Set the list of developers of the program.
:meth:`~wx.adv.AboutDialogInfo.SetDocWriters`                                    Set the list of documentation writers.
:meth:`~wx.adv.AboutDialogInfo.SetIcon`                                          Set the icon to be shown in the dialog.
:meth:`~wx.adv.AboutDialogInfo.SetLicence`                                       Set the long, multiline string containing the text of the program licence.
:meth:`~wx.adv.AboutDialogInfo.SetLicense`                                       This is the same as :meth:`~AboutDialogInfo.SetLicence` .
:meth:`~wx.adv.AboutDialogInfo.SetName`                                          Set the name of the program.
:meth:`~wx.adv.AboutDialogInfo.SetTranslators`                                   Set the list of translators.
:meth:`~wx.adv.AboutDialogInfo.SetVersion`                                       Set the version of the program.
:meth:`~wx.adv.AboutDialogInfo.SetWebSite`                                       Set the web site for the program and its description (which defaults to `url`  itself if empty).
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.adv.AboutDialogInfo.Artists`                                          See :meth:`~wx.adv.AboutDialogInfo.GetArtists` and :meth:`~wx.adv.AboutDialogInfo.SetArtists`
:attr:`~wx.adv.AboutDialogInfo.Copyright`                                        See :meth:`~wx.adv.AboutDialogInfo.GetCopyright` and :meth:`~wx.adv.AboutDialogInfo.SetCopyright`
:attr:`~wx.adv.AboutDialogInfo.Description`                                      See :meth:`~wx.adv.AboutDialogInfo.GetDescription` and :meth:`~wx.adv.AboutDialogInfo.SetDescription`
:attr:`~wx.adv.AboutDialogInfo.Developers`                                       See :meth:`~wx.adv.AboutDialogInfo.GetDevelopers` and :meth:`~wx.adv.AboutDialogInfo.SetDevelopers`
:attr:`~wx.adv.AboutDialogInfo.DocWriters`                                       See :meth:`~wx.adv.AboutDialogInfo.GetDocWriters` and :meth:`~wx.adv.AboutDialogInfo.SetDocWriters`
:attr:`~wx.adv.AboutDialogInfo.Icon`                                             See :meth:`~wx.adv.AboutDialogInfo.GetIcon` and :meth:`~wx.adv.AboutDialogInfo.SetIcon`
:attr:`~wx.adv.AboutDialogInfo.Licence`                                          See :meth:`~wx.adv.AboutDialogInfo.GetLicence` and :meth:`~wx.adv.AboutDialogInfo.SetLicence`
:attr:`~wx.adv.AboutDialogInfo.LongVersion`                                      See :meth:`~wx.adv.AboutDialogInfo.GetLongVersion`
:attr:`~wx.adv.AboutDialogInfo.Name`                                             See :meth:`~wx.adv.AboutDialogInfo.GetName` and :meth:`~wx.adv.AboutDialogInfo.SetName`
:attr:`~wx.adv.AboutDialogInfo.Translators`                                      See :meth:`~wx.adv.AboutDialogInfo.GetTranslators` and :meth:`~wx.adv.AboutDialogInfo.SetTranslators`
:attr:`~wx.adv.AboutDialogInfo.Version`                                          See :meth:`~wx.adv.AboutDialogInfo.GetVersion` and :meth:`~wx.adv.AboutDialogInfo.SetVersion`
:attr:`~wx.adv.AboutDialogInfo.WebSiteDescription`                               See :meth:`~wx.adv.AboutDialogInfo.GetWebSiteDescription`
:attr:`~wx.adv.AboutDialogInfo.WebSiteURL`                                       See :meth:`~wx.adv.AboutDialogInfo.GetWebSiteURL`
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.adv.AboutDialogInfo(object)

   **Possible constructors**::

       AboutDialogInfo()
       
   
   AboutDialogInfo contains information shown in the standard About
   dialog displayed by the AboutBox() function.



   .. method:: __init__(self)

      Default constructor leaves all fields are initially uninitialized, in general you should call at least :meth:`SetVersion` , :meth:`SetCopyright`   and :meth:`SetDescription` .                   





   .. method:: AddArtist(self, artist)

      Adds an artist name to be shown in the program credits.                  

                


      :param `artist`: 
      :type `artist`: string






      .. seealso:: :meth:`SetArtists`     








   .. method:: AddDeveloper(self, developer)

      Adds a developer name to be shown in the program credits.                  

                


      :param `developer`: 
      :type `developer`: string






      .. seealso:: :meth:`SetDevelopers`     








   .. method:: AddDocWriter(self, docwriter)

      Adds a documentation writer name to be shown in the program credits.                  

                


      :param `docwriter`: 
      :type `docwriter`: string






      .. seealso:: :meth:`SetDocWriters`     








   .. method:: AddTranslator(self, translator)

      Adds a translator name to be shown in the program credits.                  

      Notice that if no translator names are specified explicitly, :ref:`wx.adv.AboutBox`  will try to use the translation of the string  ``translator-credits``   from the currently used message catalog  –  this can be used to show just the name of the translator of the program in the current language. 

                


      :param `translator`: 
      :type `translator`: string






      .. seealso:: :meth:`SetTranslators`     








   .. method:: GetArtists(self)

      Returns an array of the artist strings set in the dialog info.                  

      :rtype: `list of strings`








   .. method:: GetCopyright(self)

      Get the copyright string.                  

                

      :rtype: `string`







      :returns: 

         The copyright string   








   .. method:: GetDescription(self)

      Get the description string.                  

                

      :rtype: `string`







      :returns: 

         The description string, free-form.   








   .. method:: GetDevelopers(self)

      Returns an array of the developer strings set in the dialog info.                  

      :rtype: `list of strings`








   .. method:: GetDocWriters(self)

      Returns an array of the writer strings set in the dialog info.                  

      :rtype: `list of strings`








   .. method:: GetIcon(self)

      Returns the icon set by :meth:`SetIcon` .                  

      :rtype: :ref:`Icon`








   .. method:: GetLicence(self)

      Returns the licence string.                  

                

      :rtype: `string`







      .. seealso:: :meth:`SetLicence`     








   .. method:: GetLongVersion(self)

      Return the long version string if set.                  

                

      :rtype: `string`







      .. seealso:: :meth:`SetVersion`     








   .. method:: GetName(self)

      Get the name of the program.                  

                

      :rtype: `string`







      :returns: 

         Name of the program   







      .. seealso:: :meth:`SetName`     








   .. method:: GetTranslators(self)

      Returns an array of the translator strings set in the dialog info.                  

      :rtype: `list of strings`








   .. method:: GetVersion(self)

      Return the short version string.                  

                

      :rtype: `string`







      .. seealso:: :meth:`SetVersion`     








   .. method:: GetWebSiteDescription(self)

      Returns the description of the website URL set for the dialog.                  

      :rtype: `string`








   .. method:: GetWebSiteURL(self)

      Returns the website URL set for the dialog.                  

      :rtype: `string`








   .. method:: HasArtists(self)

      Returns ``True`` if artists have been set in the dialog info.                  

      :rtype: `bool`








   .. method:: HasCopyright(self)

      Returns ``True`` if a copyright string has been specified.                  

                

      :rtype: `bool`







      .. seealso:: :meth:`GetCopyright`     








   .. method:: HasDescription(self)

      Returns ``True`` if a description string has been specified.                  

                

      :rtype: `bool`







      .. seealso:: :meth:`GetDescription`     








   .. method:: HasDevelopers(self)

      Returns ``True`` if developers have been set in the dialog info.                  

      :rtype: `bool`








   .. method:: HasDocWriters(self)

      Returns ``True`` if writers have been set in the dialog info.                  

      :rtype: `bool`








   .. method:: HasIcon(self)

      Returns ``True`` if an icon has been set for the about dialog.                  

      :rtype: `bool`








   .. method:: HasLicence(self)

      Returns ``True`` if the licence string has been set.                  

      :rtype: `bool`








   .. method:: HasTranslators(self)

      Returns ``True`` if translators have been set in the dialog info.                  

      :rtype: `bool`








   .. method:: HasWebSite(self)

      Returns ``True`` if the website info has been set.                  

      :rtype: `bool`








   .. method:: SetArtists(self, artists)

      Sets the list of artists to be shown in the program credits.                  

                


      :param `artists`: 
      :type `artists`: list of strings






      .. seealso:: :meth:`AddArtist`     








   .. method:: SetCopyright(self, copyright)

      Set the short string containing the program copyright information.                  

      Notice that any occurrences of  ``"(C)"``   in  `copyright`  will be replaced by the copyright symbol (circled C) automatically, which means that you can avoid using this symbol in the program source code which can be problematic,                  


      :param `copyright`: 
      :type `copyright`: string







   .. method:: SetDescription(self, desc)

      Set brief, but possibly multiline, description of the program.                  


      :param `desc`: 
      :type `desc`: string







   .. method:: SetDevelopers(self, developers)

      Set the list of developers of the program.                  

                


      :param `developers`: 
      :type `developers`: list of strings






      .. seealso:: :meth:`AddDeveloper`     








   .. method:: SetDocWriters(self, docwriters)

      Set the list of documentation writers.                  

                


      :param `docwriters`: 
      :type `docwriters`: list of strings






      .. seealso:: :meth:`AddDocWriter`     








   .. method:: SetIcon(self, icon)

      Set the icon to be shown in the dialog.                  

      By default the icon of the main frame will be shown if the native about dialog supports custom icons. If it doesn't but a valid icon is specified using this method, the generic about dialog is used instead so you should avoid calling this function for maximally native look and feel.                  


      :param `icon`: 
      :type `icon`: wx.Icon







   .. method:: SetLicence(self, licence)

      Set the long, multiline string containing the text of the program licence.                  

      Only GTK+ version supports showing the licence text in the native about dialog currently so the generic version will be used under all the other platforms if this method is called. To preserve the native look and feel it is advised that you do not call this method but provide a separate menu item in the  ``"Help"``   menu for displaying the text of your program licence.                   


      :param `licence`: 
      :type `licence`: string







   .. method:: SetLicense(self, licence)

      This is the same as :meth:`SetLicence` .                  


      :param `licence`: 
      :type `licence`: string







   .. method:: SetName(self, name)

      Set the name of the program.                  

      If this method is not called, the string returned by :meth:`wx.App.GetAppName`   will be shown in the dialog.                  


      :param `name`: 
      :type `name`: string







   .. method:: SetTranslators(self, translators)

      Set the list of translators.                  

      Please see :meth:`AddTranslator`   for additional discussion.                  


      :param `translators`: 
      :type `translators`: list of strings







   .. method:: SetVersion(self, version, longVersion="")

      Set the version of the program.                  

      The word "version" shouldn't be included in `version`. Example `version`  values: "1.2" and "``RC2``". In about dialogs with more space set aside for version information, `longVersion`  is used. Example `longVersion`  values: "Version 1.2" and "Release Candidate 2". If `version`  is non-empty but `longVersion`  is empty, a long version is constructed automatically, using `version`  (by simply prepending "Version " to `version`). 

      The generic about dialog and native GTK+ dialog use `version`  only, as a suffix to the program name. The native MSW and macOS about dialogs use the long version.                  


      :param `version`: 
      :type `version`: string
      :param `longVersion`: 
      :type `longVersion`: string







   .. method:: SetWebSite(self, url, desc=EmptyString)

      Set the web site for the program and its description (which defaults to `url`  itself if empty).                  

      Please notice that only GTK+ version currently supports showing the link in the native about dialog so if this method is called, the generic version will be used under all the other platforms.                  


      :param `url`: 
      :type `url`: string
      :param `desc`: 
      :type `desc`: string







   .. attribute:: Artists

      See :meth:`~wx.adv.AboutDialogInfo.GetArtists` and :meth:`~wx.adv.AboutDialogInfo.SetArtists`


   .. attribute:: Copyright

      See :meth:`~wx.adv.AboutDialogInfo.GetCopyright` and :meth:`~wx.adv.AboutDialogInfo.SetCopyright`


   .. attribute:: Description

      See :meth:`~wx.adv.AboutDialogInfo.GetDescription` and :meth:`~wx.adv.AboutDialogInfo.SetDescription`


   .. attribute:: Developers

      See :meth:`~wx.adv.AboutDialogInfo.GetDevelopers` and :meth:`~wx.adv.AboutDialogInfo.SetDevelopers`


   .. attribute:: DocWriters

      See :meth:`~wx.adv.AboutDialogInfo.GetDocWriters` and :meth:`~wx.adv.AboutDialogInfo.SetDocWriters`


   .. attribute:: Icon

      See :meth:`~wx.adv.AboutDialogInfo.GetIcon` and :meth:`~wx.adv.AboutDialogInfo.SetIcon`


   .. attribute:: Licence

      See :meth:`~wx.adv.AboutDialogInfo.GetLicence` and :meth:`~wx.adv.AboutDialogInfo.SetLicence`


   .. attribute:: LongVersion

      See :meth:`~wx.adv.AboutDialogInfo.GetLongVersion`


   .. attribute:: Name

      See :meth:`~wx.adv.AboutDialogInfo.GetName` and :meth:`~wx.adv.AboutDialogInfo.SetName`


   .. attribute:: Translators

      See :meth:`~wx.adv.AboutDialogInfo.GetTranslators` and :meth:`~wx.adv.AboutDialogInfo.SetTranslators`


   .. attribute:: Version

      See :meth:`~wx.adv.AboutDialogInfo.GetVersion` and :meth:`~wx.adv.AboutDialogInfo.SetVersion`


   .. attribute:: WebSiteDescription

      See :meth:`~wx.adv.AboutDialogInfo.GetWebSiteDescription`


   .. attribute:: WebSiteURL

      See :meth:`~wx.adv.AboutDialogInfo.GetWebSiteURL`

