cheng/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

more utils.h fixes

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52732 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Václav Slavík 2008-03-23 12:41:23 +00:00
parent 74bda2038c
commit ce323d38d3
1 changed files with 26 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
interface/utils.h
View File

@ -271,25 +271,31 @@ void wxError(const wxString& message,
*/ */
wxPowerType wxGetPowerType(); wxPowerType wxGetPowerType();
//@{
/** /**
This function returns the "user id" also known as "login name" under Unix i.e. This function returns the "user id" also known as "login name" under Unix
something like "jsmith". It uniquely identifies the current user (on this i.e. something like "jsmith". It uniquely identifies the current user (on
system). this system). Under Windows or NT, this function first looks in the
Under Windows or NT, this function first looks in the environment environment variables USER and LOGNAME; if neither of these is found, the
variables USER and LOGNAME; if neither of these is found, the entry @b UserId entry @b UserId in the @b wxWidgets section of the WIN.INI file is tried.
in the @b wxWidgets section of the WIN.INI file is tried.
The first variant of this function returns the login name if successful or an @return Returns the login name if successful or an empty string otherwise.
empty string otherwise. The second (deprecated) function returns @true
if successful, @false otherwise.
@see wxGetUserName() @see wxGetUserName()
@header{wx/utils.h} @header{wx/utils.h}
*/ */
wxString wxGetUserId(); wxString wxGetUserId();
/**
@deprecated
This form is deprecated, use wxGetUserId() version that returns wxString.
@param buf Buffer to store login name in.
@param sz Size of the buffer.
@return Returns @true if successful, @false otherwise.
*/
bool wxGetUserId(char* buf, int sz); bool wxGetUserId(char* buf, int sz);
//@}
/** /**
Returns battery state as one of @c wxBATTERY_NORMAL_STATE, Returns battery state as one of @c wxBATTERY_NORMAL_STATE,
@ -303,20 +309,18 @@ bool wxGetUserId(char* buf, int sz);
wxBatteryState wxGetBatteryState(); wxBatteryState wxGetBatteryState();
/** /**
@b NB: This function is obsolete, please use @deprecated
wxWindow::FindWindowByName instead. This function is obsolete, please use wxWindow::FindWindowByName() instead.
Find a window by its name (as given in a window constructor or @b Create
function call). Find a window by its name (as given in a window constructor or Create()
If @a parent is @NULL, the search will start from all top-level function call). If @a parent is @NULL, the search will start from all
frames and dialog boxes; if non-@NULL, the search will be limited to the given top-level frames and dialog boxes; if non-@NULL, the search will be limited
window hierarchy. to the given window hierarchy. The search is recursive in both cases. If
The search is recursive in both cases. no such named window is found, wxFindWindowByLabel() is called.
If no such named window is found, @b wxFindWindowByLabel is called.
@header{wx/utils.h} @header{wx/utils.h}
*/ */
wxWindow* wxFindWindowByName(const wxString& name, wxWindow* wxFindWindowByName(const wxString& name, wxWindow* parent = NULL);
wxWindow* parent = NULL);
/** /**
This function is deprecated as the ids generated by it can conflict with the This function is deprecated as the ids generated by it can conflict with the