]> git.saurik.com Git - wxWidgets.git/blob - interface/wx/versioninfo.h
put both versions of wxGetMousePosition in one place so they can use one implementation
[wxWidgets.git] / interface / wx / versioninfo.h
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}
20
21 @category{data}
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 */
43 wxVersionInfo(const wxString& name = wxString(),
44 int major = 0,
45 int minor = 0,
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 */
95 wxString GetVersionString() const;
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 //@}