[wxWidgets.git] / interface / wx / versioninfo.h

/////////////////////////////////////////////////////////////////////////////
// Name:        versioninfo.h
// Purpose:     interface of wxVersionInfo
// Author:      Troels K
// RCS-ID:      $Id: versioninfo.h
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

/**
    @class wxVersionInfo

    wxVersionInfo contains version information.

    This class is used by wxWidgets to provide version information about the
    libraries it uses and itself, but you can also apply it in user space, to
    provide version information about your own libraries, or other libraries
    that you use.

    @library{wxbase}

    @category{data}

    @since 2.9.2
*/
class wxVersionInfo
{
public:
    /**
        Constructor.

        The version information objects need to be initialized with this
        constructor and are immutable once they are created.

        @param name The name of the library or other entity that this object
            pertains to.
        @param major The major version component.
        @param minor The minor version component.
        @param micro The micro version component, 0 by default.
        @param description Free form description of this version, none by
            default.
        @param copyright Copyright string, none by default.
    */
    wxVersionInfo(const wxString& name = wxString(),
                  int major = 0,
                  int minor = 0,
                  int micro = 0,
                  const wxString& description = wxString(),
                  const wxString& copyright = wxString());

    /**
        Get the name of the object (library).

        @return Name string.
    */
    const wxString& GetName() const;

    /**
        Get the major version number.

        @return Major version number.
    */
    int GetMajor() const;

    /**
        Get the minor version number.

        @return Minor version number.
    */
    int GetMinor() const;

    /**
        Get the micro version, or release number.

        @return Micro version, or release number.
    */
    int GetMicro() const;

    /**
        Get the string representation of this version object.

        This function returns the description if it is non-empty or
        GetVersionString() if there is no description.

        @see GetDescription(), GetVersionString()
    */
    wxString ToString() const;

    /**
        Get the string representation.

        The micro component of the version is ignored/not used if it is 0.

        @return The version string in the form "name major.minor[.micro]".
    */
    wxString GetVersionString() const;

    /**
        Return @true if a description string has been specified.

        @see GetDescription()
    */
    bool HasDescription() const;

    /**
        Get the description string.

        The description may be empty.

        @return The description string, free-form.
    */
    const wxString& GetDescription();

    /**
        Returns @true if a copyright string has been specified.

        @see GetCopyright()
    */
    bool HasCopyright() const;

    /**
        Get the copyright string.

        The copyright string may be empty.

        @return The copyright string.
    */
    const wxString& GetCopyright() const;
};

//@}
Commit	Line	Data
ccec9093 VZ	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: versioninfo.h
	3	// Purpose: interface of wxVersionInfo
	4	// Author: Troels K
	5	// RCS-ID: $Id: versioninfo.h
	6	// Licence: wxWindows licence
	7	/////////////////////////////////////////////////////////////////////////////
	8
	9	/**
	10	@class wxVersionInfo
	11
	12	wxVersionInfo contains version information.
	13
	14	This class is used by wxWidgets to provide version information about the
	15	libraries it uses and itself, but you can also apply it in user space, to
	16	provide version information about your own libraries, or other libraries
	17	that you use.
	18
	19	@library{wxbase}
ce45dbe3	20
ccec9093	21	@category{data}
ccec9093 VZ	22
	23	@since 2.9.2
	24	*/
	25	class wxVersionInfo
	26	{
	27	public:
	28	/**
	29	Constructor.
	30
	31	The version information objects need to be initialized with this
	32	constructor and are immutable once they are created.
	33
	34	@param name The name of the library or other entity that this object
	35	pertains to.
	36	@param major The major version component.
	37	@param minor The minor version component.
	38	@param micro The micro version component, 0 by default.
	39	@param description Free form description of this version, none by
	40	default.
	41	@param copyright Copyright string, none by default.
	42	*/
3d2ee2fb RD	43	wxVersionInfo(const wxString& name = wxString(),
	44	int major = 0,
	45	int minor = 0,
ccec9093 VZ	46	int micro = 0,
	47	const wxString& description = wxString(),
	48	const wxString& copyright = wxString());
	49
	50	/**
	51	Get the name of the object (library).
	52
	53	@return Name string.
	54	*/
	55	const wxString& GetName() const;
	56
	57	/**
	58	Get the major version number.
	59
	60	@return Major version number.
	61	*/
	62	int GetMajor() const;
	63
	64	/**
	65	Get the minor version number.
	66
	67	@return Minor version number.
	68	*/
	69	int GetMinor() const;
	70
	71	/**
	72	Get the micro version, or release number.
	73
	74	@return Micro version, or release number.
	75	*/
	76	int GetMicro() const;
	77
	78	/**
	79	Get the string representation of this version object.
	80
	81	This function returns the description if it is non-empty or
	82	GetVersionString() if there is no description.
	83
	84	@see GetDescription(), GetVersionString()
	85	*/
	86	wxString ToString() const;
	87
	88	/**
	89	Get the string representation.
	90
	91	The micro component of the version is ignored/not used if it is 0.
	92
	93	@return The version string in the form "name major.minor[.micro]".
	94	*/
b821341a	95	wxString GetVersionString() const;
ccec9093 VZ	96
	97	/**
	98	Return @true if a description string has been specified.
	99
	100	@see GetDescription()
	101	*/
	102	bool HasDescription() const;
	103
	104	/**
	105	Get the description string.
	106
	107	The description may be empty.
	108
	109	@return The description string, free-form.
	110	*/
	111	const wxString& GetDescription();
	112
	113	/**
	114	Returns @true if a copyright string has been specified.
	115
	116	@see GetCopyright()
	117	*/
	118	bool HasCopyright() const;
	119
	120	/**
	121	Get the copyright string.
	122
	123	The copyright string may be empty.
	124
	125	@return The copyright string.
	126	*/
	127	const wxString& GetCopyright() const;
	128	};
	129
	130	//@}