anne/lyx_mirror
1
0
Fork 0
mirror of https://git.lyx.org/repos/lyx.git synced 2024-11-22 10:00:33 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

better documentation for isValidLength and stringFromUnit

Browse Source 
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@13844 a592a061-630c-0410-9148-cb99ea01b6c8
This commit is contained in:
Georg Baum 2006-05-12 19:06:19 +00:00
parent 0b9b87d142
commit e1019394f8
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/lyxlength.h
View File

@ -102,10 +102,18 @@ private:
bool operator==(LyXLength const & l1, LyXLength const & l2);
///
bool operator!=(LyXLength const & l1, LyXLength const & l2);
/** If "data" is valid, the length represented by it is
stored into "result", if that is not 0. */
/** Test whether \p data represents a valid length.
*
* \returns whether \p data is a valid length
* \param data Length in LyX format. Since the only difference between LyX
* and LaTeX format is the representation of length variables as units (e.g.
* \c text% vs. \c \\textwidth) you can actually use this function as well
* for testing LaTeX lengths as long as they only contain real units like pt.
* \param result Pointer to a LyXLength variable. If \p result is not 0 and
* \p data is valid, the length represented by it is stored into \p result.
*/
bool isValidLength(std::string const & data, LyXLength * result = 0);
/// return the name of the given unit number
/// return the LyX name of the given unit number
char const * stringFromUnit(int unit);
#endif // LYXLENGTH_H