# :stopdoc:
# This file is automatically generated by the WXRuby3 documentation 
# generator. Do not alter this file.
# :startdoc:


module Wx

  # This function shows the standard about dialog containing the information specified in info.
  # If the current platform has a native about dialog which is capable of showing all the fields in info, the native dialog is used, otherwise the function falls back to the generic wxWidgets version of the dialog, i.e. does the same thing as {generic_about_box}.
  # Here is an example of how this function may be used:
  # 
  #   void MyFrame::ShowSimpleAboutDialog(wxCommandEvent& WXUNUSED(event))
  #   {
  #       wxAboutDialogInfo info;
  #       info.SetName(_("My Program"));
  #       info.SetVersion(_("1.2.3 Beta"));
  #       info.SetDescription(_("This program does something great."));
  #       info.SetCopyright(wxT("(C) 2007 Me <my@email.addre.ss>"));
  #   
  #       wxAboutBox(info);
  #   }
  # 
  # Please see the Dialogs Sample for more examples of using this function and {Wx::AboutDialogInfo} for the description of the information which can be shown in the about dialog.
  # Include file: #include <wx/aboutdlg.h>
  # @param info [Wx::AboutDialogInfo] 
  # @param parent [Wx::Window] 
  # @return [void]
  def self.about_box(info, parent=nil) end
  
  # This function does the same thing as {about_box} except that it always uses the generic wxWidgets version of the dialog instead of the native one.
  # This is mainly useful if you need to customize the dialog by e.g. adding custom controls to it (customizing the native dialog is not currently supported).
  # See the Dialogs Sample for an example of about dialog customization.
  # 
  # Include file: #include <wx/aboutdlg.h>
  # @see Wx::AboutDialogInfo
  # @param info [Wx::AboutDialogInfo] 
  # @param parent [Wx::Window] 
  # @return [void]
  def self.generic_about_box(info, parent=nil) end
  
  # {Wx::AboutDialogInfo} contains information shown in the standard About dialog displayed by the {about_box} 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 {Wx::ArrayString} and can be either set entirely at once using {Wx::AboutDialogInfo#set_developers} and similar functions or built one by one using {Wx::AboutDialogInfo#add_developer} 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 {Wx::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, {about_box} will automatically use the generic version so you should avoid specifying these fields to achieve more native look and feel.
  # Example of usage: 
  # 
  #   void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
  #   {
  #       wxAboutDialogInfo aboutInfo;
  #       aboutInfo.SetName("MyApp");
  #       aboutInfo.SetVersion(MY_APP_VERSION_STRING);
  #       aboutInfo.SetDescription(_("My wxWidgets-based application!"));
  #       aboutInfo.SetCopyright("(C) 1992-2023");
  #       aboutInfo.SetWebSite("http://myapp.org");
  #       aboutInfo.AddDeveloper("My Self");
  #   
  #       wxAboutBox(aboutInfo);
  #   }
  # 
  # === 
  # 
  # Category:  Common Dialogs, Data Structures
  # @see Wx::AboutDialogInfo#set_artists 
  # 
  # 
  class AboutDialogInfo < ::Object
  
    # Default constructor leaves all fields are initially uninitialized, in general you should call at least {Wx::AboutDialogInfo#set_version}, {Wx::AboutDialogInfo#set_copyright} and {Wx::AboutDialogInfo#set_description}.
    # @return [AboutDialogInfo]
    def initialize; end
    
    # Adds an artist name to be shown in the program credits.
    # 
    # @see Wx::AboutDialogInfo#set_artists 
    # @param artist [String] 
    # @return [void]
    def add_artist(artist) end
    
    # Adds a developer name to be shown in the program credits.
    # 
    # @see Wx::AboutDialogInfo#set_developers 
    # @param developer [String] 
    # @return [void]
    def add_developer(developer) end
    
    # Adds a documentation writer name to be shown in the program credits.
    # 
    # @see Wx::AboutDialogInfo#set_doc_writers 
    # @param docwriter [String] 
    # @return [void]
    def add_doc_writer(docwriter) end
    
    # Adds a translator name to be shown in the program credits.
    # Notice that if no translator names are specified explicitly, {about_box} will try to use the translation of the string <code>translator-credits</code> 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.
    # @see Wx::AboutDialogInfo#set_translators 
    # @param translator [String] 
    # @return [void]
    def add_translator(translator) end
    
    # Get the name of the program.
    # Name of the program
    # @see Wx::AboutDialogInfo#set_name 
    # @return [String]
    def get_name; end
    alias_method :name, :get_name
    
    # Returns true if a description string has been specified.
    # 
    # @see Wx::AboutDialogInfo#get_description 
    # @return [true,false]
    def has_description; end
    alias_method :has_description?, :has_description
    
    # Get the description string.
    # The description string, free-form.
    # @return [Wx::String]
    def get_description; end
    alias_method :description, :get_description
    
    # Returns true if a copyright string has been specified.
    # 
    # @see Wx::AboutDialogInfo#get_copyright 
    # @return [true,false]
    def has_copyright; end
    alias_method :has_copyright?, :has_copyright
    
    # Get the copyright string.
    # The copyright string
    # @return [Wx::String]
    def get_copyright; end
    alias_method :copyright, :get_copyright
    
    # Sets the list of artists to be shown in the program credits.
    # 
    # @see Wx::AboutDialogInfo#add_artist 
    # @param artists [Array<String>] 
    # @return [void]
    def set_artists(artists) end
    alias_method :artists=, :set_artists
    
    # Set the short string containing the program copyright information.
    # Notice that any occurrences of <code>"(C)"</code> 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 [String] 
    # @return [void]
    def set_copyright(copyright) end
    alias_method :copyright=, :set_copyright
    
    # Set brief, but possibly multiline, description of the program.
    # @param desc [String] 
    # @return [void]
    def set_description(desc) end
    alias_method :description=, :set_description
    
    # Set the list of developers of the program.
    # 
    # @see Wx::AboutDialogInfo#add_developer 
    # @param developers [Array<String>] 
    # @return [void]
    def set_developers(developers) end
    alias_method :developers=, :set_developers
    
    # Set the list of documentation writers.
    # 
    # @see Wx::AboutDialogInfo#add_doc_writer 
    # @param docwriters [Array<String>] 
    # @return [void]
    def set_doc_writers(docwriters) end
    alias_method :doc_writers=, :set_doc_writers
    
    # Returns true if an icon has been set for the about dialog.
    # @return [true,false]
    def has_icon; end
    alias_method :has_icon?, :has_icon
    
    # Returns the icon set by {Wx::AboutDialogInfo#set_icon}.
    # @return [Wx::Icon]
    def get_icon; end
    alias_method :icon, :get_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 [Wx::Icon] 
    # @return [void]
    def set_icon(icon) end
    alias_method :icon=, :set_icon
    
    # Returns true if the licence string has been set.
    # @return [true,false]
    def has_licence; end
    alias_method :has_licence?, :has_licence
    
    # Returns the licence string.
    # 
    # @see Wx::AboutDialogInfo#set_licence 
    # @return [Wx::String]
    def get_licence; end
    alias_method :licence, :get_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 <code>"Help"</code> menu for displaying the text of your program licence.
    # @param licence [String] 
    # @return [void]
    def set_licence(licence) end
    alias_method :licence=, :set_licence
    
    # This is the same as {Wx::AboutDialogInfo#set_licence}.
    # @param licence [String] 
    # @return [void]
    def set_license(licence) end
    alias_method :license=, :set_license
    
    # Set the name of the program.
    # If this method is not called, the string returned by {Wx::App::GetAppName} will be shown in the dialog.
    # @param name [String] 
    # @return [void]
    def set_name(name) end
    alias_method :name=, :set_name
    
    # Set the list of translators.
    # Please see {Wx::AboutDialogInfo#add_translator} for additional discussion.
    # @param translators [Array<String>] 
    # @return [void]
    def set_translators(translators) end
    alias_method :translators=, :set_translators
    
    # 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 [String] 
    # @param longVersion [String] 
    # @return [void]
    def set_version(version, longVersion=(())) end
    alias_method :version=, :set_version
    
    # Return the short version string.
    # 
    # @see Wx::AboutDialogInfo#set_version 
    # @return [Wx::String]
    def get_version; end
    alias_method :version, :get_version
    
    # Return the long version string if set.
    # 
    # @see Wx::AboutDialogInfo#set_version 
    # @return [Wx::String]
    def get_long_version; end
    alias_method :long_version, :get_long_version
    
    # Returns true if the website info has been set.
    # @return [true,false]
    def has_web_site; end
    alias_method :has_web_site?, :has_web_site
    
    # Returns the website URL set for the dialog.
    # @return [Wx::String]
    def get_web_site_url; end
    alias_method :web_site_url, :get_web_site_url
    
    # Returns the description of the website URL set for the dialog.
    # @return [Wx::String]
    def get_web_site_description; end
    alias_method :web_site_description, :get_web_site_description
    
    # 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 [String] 
    # @param desc [String] 
    # @return [void]
    def set_web_site(url, desc=Wx::EMPTY_STRING) end
    alias_method :web_site=, :set_web_site
    
    # Returns true if developers have been set in the dialog info.
    # @return [true,false]
    def has_developers; end
    alias_method :has_developers?, :has_developers
    
    # Returns an array of the developer strings set in the dialog info.
    # @return [Wx::ArrayString]
    def get_developers; end
    alias_method :developers, :get_developers
    
    # Returns true if writers have been set in the dialog info.
    # @return [true,false]
    def has_doc_writers; end
    alias_method :has_doc_writers?, :has_doc_writers
    
    # Returns an array of the writer strings set in the dialog info.
    # @return [Wx::ArrayString]
    def get_doc_writers; end
    alias_method :doc_writers, :get_doc_writers
    
    # Returns true if artists have been set in the dialog info.
    # @return [true,false]
    def has_artists; end
    alias_method :has_artists?, :has_artists
    
    # Returns an array of the artist strings set in the dialog info.
    # @return [Wx::ArrayString]
    def get_artists; end
    alias_method :artists, :get_artists
    
    # Returns true if translators have been set in the dialog info.
    # @return [true,false]
    def has_translators; end
    alias_method :has_translators?, :has_translators
    
    # Returns an array of the translator strings set in the dialog info.
    # @return [Wx::ArrayString]
    def get_translators; end
    alias_method :translators, :get_translators
    
  end # AboutDialogInfo
  

end