diff options
author | Friedemann Kleint <[email protected]> | 2011-03-02 17:13:33 +0100 |
---|---|---|
committer | Friedemann Kleint <[email protected]> | 2011-03-02 17:14:19 +0100 |
commit | 505256fab9db5ef479ebc69e46191b1a0a605919 (patch) | |
tree | dd01d8c8673867c73563566693c46737d097d4e4 /src/libs/utils/basevalidatinglineedit.cpp | |
parent | b37cd3325cce75a054c3de59b39f1e935b70ef06 (diff) |
API-Documentation: Add the Utils-library.
Fix API after doc template change.
Diffstat (limited to 'src/libs/utils/basevalidatinglineedit.cpp')
-rw-r--r-- | src/libs/utils/basevalidatinglineedit.cpp | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/src/libs/utils/basevalidatinglineedit.cpp b/src/libs/utils/basevalidatinglineedit.cpp index bbe41a292c7..1eb7ab5a889 100644 --- a/src/libs/utils/basevalidatinglineedit.cpp +++ b/src/libs/utils/basevalidatinglineedit.cpp @@ -37,6 +37,27 @@ enum { debug = 0 }; +/*! + \namespace Utils + General utility library namespace +*/ + +/*! \class Utils::BaseValidatingLineEdit + + \brief Base class for line edits that perform validation. + + Performs validation in a virtual validate() function to be implemented in + derived classes. + When invalid, the text color will turn red and a tooltip will + contain the error message. This approach is less intrusive than a + QValidator which will prevent the user from entering certain characters. + + The widget has a concept of an "initialText" which can be something like + "<Enter name here>". This results in state 'DisplayingInitialText', which + is not valid, but is not marked red. +*/ + + namespace Utils { struct BaseValidatingLineEditPrivate { |