/usr/share/qt3/doc/html/qcstring.html is in qt3-doc 3:3.3.8-b-8ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/tools/qcstring.cpp:567 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QCString Class</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
<a href="index.html">
<font color="#004faf">Home</font></a>
| <a href="classes.html">
<font color="#004faf">All Classes</font></a>
| <a href="mainclasses.html">
<font color="#004faf">Main Classes</font></a>
| <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
| <a href="groups.html">
<font color="#004faf">Grouped Classes</font></a>
| <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QCString Class Reference</h1>
<p>The QCString class provides an abstraction of the classic C
zero-terminated char array (char *).
<a href="#details">More...</a>
<p>All the functions in this class are <a href="threads.html#reentrant">reentrant</a> when Qt is built with thread support.</p>
<p><tt>#include <<a href="qcstring-h.html">qcstring.h</a>></tt>
<p>Inherits <a href="qbytearray.html">QByteArray</a>.
<p><a href="qcstring-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn><a href="#QCString"><b>QCString</b></a> ()</li>
<li class=fn><a href="#QCString-2"><b>QCString</b></a> ( int size )</li>
<li class=fn><a href="#QCString-3"><b>QCString</b></a> ( const QCString & s )</li>
<li class=fn><a href="#QCString-4"><b>QCString</b></a> ( const char * str )</li>
<li class=fn><a href="#QCString-5"><b>QCString</b></a> ( const char * str, uint maxsize )</li>
<li class=fn>QCString & <a href="#operator-eq"><b>operator=</b></a> ( const QCString & s )</li>
<li class=fn>QCString & <a href="#operator-eq-2"><b>operator=</b></a> ( const char * str )</li>
<li class=fn>bool <a href="#isNull"><b>isNull</b></a> () const</li>
<li class=fn>bool <a href="#isEmpty"><b>isEmpty</b></a> () const</li>
<li class=fn>uint <a href="#length"><b>length</b></a> () const</li>
<li class=fn>bool <a href="#resize"><b>resize</b></a> ( uint len )</li>
<li class=fn>bool <a href="#truncate"><b>truncate</b></a> ( uint pos )</li>
<li class=fn>bool <a href="#fill"><b>fill</b></a> ( char c, int len = -1 )</li>
<li class=fn>QCString <a href="#copy"><b>copy</b></a> () const</li>
<li class=fn>QCString & <a href="#sprintf"><b>sprintf</b></a> ( const char * format, ... )</li>
<li class=fn>int <a href="#find"><b>find</b></a> ( char c, int index = 0, bool cs = TRUE ) const</li>
<li class=fn>int <a href="#find-2"><b>find</b></a> ( const char * str, int index = 0, bool cs = TRUE ) const</li>
<li class=fn>int <a href="#find-3"><b>find</b></a> ( const QRegExp & rx, int index = 0 ) const</li>
<li class=fn>int <a href="#findRev"><b>findRev</b></a> ( char c, int index = -1, bool cs = TRUE ) const</li>
<li class=fn>int <a href="#findRev-2"><b>findRev</b></a> ( const char * str, int index = -1, bool cs = TRUE ) const</li>
<li class=fn>int <a href="#findRev-3"><b>findRev</b></a> ( const QRegExp & rx, int index = -1 ) const</li>
<li class=fn>int <a href="#contains"><b>contains</b></a> ( char c, bool cs = TRUE ) const</li>
<li class=fn>int <a href="#contains-2"><b>contains</b></a> ( const char * str, bool cs = TRUE ) const</li>
<li class=fn>int <a href="#contains-3"><b>contains</b></a> ( const QRegExp & rx ) const</li>
<li class=fn>QCString <a href="#left"><b>left</b></a> ( uint len ) const</li>
<li class=fn>QCString <a href="#right"><b>right</b></a> ( uint len ) const</li>
<li class=fn>QCString <a href="#mid"><b>mid</b></a> ( uint index, uint len = 0xffffffff ) const</li>
<li class=fn>QCString <a href="#leftJustify"><b>leftJustify</b></a> ( uint width, char fill = ' ', bool truncate = FALSE ) const</li>
<li class=fn>QCString <a href="#rightJustify"><b>rightJustify</b></a> ( uint width, char fill = ' ', bool truncate = FALSE ) const</li>
<li class=fn>QCString <a href="#lower"><b>lower</b></a> () const</li>
<li class=fn>QCString <a href="#upper"><b>upper</b></a> () const</li>
<li class=fn>QCString <a href="#stripWhiteSpace"><b>stripWhiteSpace</b></a> () const</li>
<li class=fn>QCString <a href="#simplifyWhiteSpace"><b>simplifyWhiteSpace</b></a> () const</li>
<li class=fn>QCString & <a href="#insert-2"><b>insert</b></a> ( uint index, const char * s )</li>
<li class=fn>QCString & <a href="#insert"><b>insert</b></a> ( uint index, char c )</li>
<li class=fn>QCString & <a href="#append"><b>append</b></a> ( const char * str )</li>
<li class=fn>QCString & <a href="#prepend"><b>prepend</b></a> ( const char * s )</li>
<li class=fn>QCString & <a href="#remove"><b>remove</b></a> ( uint index, uint len )</li>
<li class=fn>QCString & <a href="#replace"><b>replace</b></a> ( uint index, uint len, const char * str )</li>
<li class=fn>QCString & <a href="#replace-2"><b>replace</b></a> ( const QRegExp & rx, const char * str )</li>
<li class=fn>QCString & <a href="#replace-3"><b>replace</b></a> ( char c, const char * after )</li>
<li class=fn>QCString & <a href="#replace-4"><b>replace</b></a> ( const char * before, const char * after )</li>
<li class=fn>QCString & <a href="#replace-5"><b>replace</b></a> ( char c1, char c2 )</li>
<li class=fn>short <a href="#toShort"><b>toShort</b></a> ( bool * ok = 0 ) const</li>
<li class=fn>ushort <a href="#toUShort"><b>toUShort</b></a> ( bool * ok = 0 ) const</li>
<li class=fn>int <a href="#toInt"><b>toInt</b></a> ( bool * ok = 0 ) const</li>
<li class=fn>uint <a href="#toUInt"><b>toUInt</b></a> ( bool * ok = 0 ) const</li>
<li class=fn>long <a href="#toLong"><b>toLong</b></a> ( bool * ok = 0 ) const</li>
<li class=fn>ulong <a href="#toULong"><b>toULong</b></a> ( bool * ok = 0 ) const</li>
<li class=fn>float <a href="#toFloat"><b>toFloat</b></a> ( bool * ok = 0 ) const</li>
<li class=fn>double <a href="#toDouble"><b>toDouble</b></a> ( bool * ok = 0 ) const</li>
<li class=fn>QCString & <a href="#setStr"><b>setStr</b></a> ( const char * str )</li>
<li class=fn>QCString & <a href="#setNum-2"><b>setNum</b></a> ( short n )</li>
<li class=fn>QCString & <a href="#setNum-3"><b>setNum</b></a> ( ushort n )</li>
<li class=fn>QCString & <a href="#setNum-4"><b>setNum</b></a> ( int n )</li>
<li class=fn>QCString & <a href="#setNum-5"><b>setNum</b></a> ( uint n )</li>
<li class=fn>QCString & <a href="#setNum-6"><b>setNum</b></a> ( long n )</li>
<li class=fn>QCString & <a href="#setNum-7"><b>setNum</b></a> ( ulong n )</li>
<li class=fn>QCString & <a href="#setNum-8"><b>setNum</b></a> ( float n, char f = 'g', int prec = 6 )</li>
<li class=fn>QCString & <a href="#setNum"><b>setNum</b></a> ( double n, char f = 'g', int prec = 6 )</li>
<li class=fn>bool <a href="#setExpand"><b>setExpand</b></a> ( uint index, char c )</li>
<li class=fn><a href="#operator-const-char-*"><b>operator const char *</b></a> () const</li>
<li class=fn>QCString & <a href="#operator+-eq"><b>operator+=</b></a> ( const char * str )</li>
<li class=fn>QCString & <a href="#operator+-eq-2"><b>operator+=</b></a> ( char c )</li>
</ul>
<h2>Related Functions</h2>
<ul>
<li class=fn>void * <a href="#qmemmove"><b>qmemmove</b></a> ( void * dst, const void * src, uint len )</li>
<li class=fn>char * <a href="#qstrdup"><b>qstrdup</b></a> ( const char * src )</li>
<li class=fn>char * <a href="#qstrcpy"><b>qstrcpy</b></a> ( char * dst, const char * src )</li>
<li class=fn>char * <a href="#qstrncpy"><b>qstrncpy</b></a> ( char * dst, const char * src, uint len )</li>
<li class=fn>uint <a href="#qstrlen"><b>qstrlen</b></a> ( const char * str )</li>
<li class=fn>int <a href="#qstrcmp"><b>qstrcmp</b></a> ( const char * str1, const char * str2 )</li>
<li class=fn>int <a href="#qstrncmp"><b>qstrncmp</b></a> ( const char * str1, const char * str2, uint len )</li>
<li class=fn>int <a href="#qstricmp"><b>qstricmp</b></a> ( const char * str1, const char * str2 )</li>
<li class=fn>int <a href="#qstrnicmp"><b>qstrnicmp</b></a> ( const char * str1, const char * str2, uint len )</li>
<li class=fn>QDataStream & <a href="#operator-lt-lt"><b>operator<<</b></a> ( QDataStream & s, const QCString & str )</li>
<li class=fn>QDataStream & <a href="#operator-gt-gt"><b>operator>></b></a> ( QDataStream & s, QCString & str )</li>
<li class=fn>bool <a href="#operator-eq-eq"><b>operator==</b></a> ( const QCString & s1, const QCString & s2 )</li>
<li class=fn>bool <a href="#operator-eq-eq-2"><b>operator==</b></a> ( const QCString & s1, const char * s2 )</li>
<li class=fn>bool <a href="#operator-eq-eq-3"><b>operator==</b></a> ( const char * s1, const QCString & s2 )</li>
<li class=fn>bool <a href="#operator!-eq"><b>operator!=</b></a> ( const QCString & s1, const QCString & s2 )</li>
<li class=fn>bool <a href="#operator!-eq-2"><b>operator!=</b></a> ( const QCString & s1, const char * s2 )</li>
<li class=fn>bool <a href="#operator!-eq-3"><b>operator!=</b></a> ( const char * s1, const QCString & s2 )</li>
<li class=fn>bool <a href="#operator-lt"><b>operator<</b></a> ( const QCString & s1, const char * s2 )</li>
<li class=fn>bool <a href="#operator-lt-2"><b>operator<</b></a> ( const char * s1, const QCString & s2 )</li>
<li class=fn>bool <a href="#operator-lt-eq"><b>operator<=</b></a> ( const QCString & s1, const char * s2 )</li>
<li class=fn>bool <a href="#operator-lt-eq-2"><b>operator<=</b></a> ( const char * s1, const QCString & s2 )</li>
<li class=fn>bool <a href="#operator-gt"><b>operator></b></a> ( const QCString & s1, const char * s2 )</li>
<li class=fn>bool <a href="#operator-gt-2"><b>operator></b></a> ( const char * s1, const QCString & s2 )</li>
<li class=fn>bool <a href="#operator-gt-eq"><b>operator>=</b></a> ( const QCString & s1, const char * s2 )</li>
<li class=fn>bool <a href="#operator-gt-eq-2"><b>operator>=</b></a> ( const char * s1, const QCString & s2 )</li>
<li class=fn>const QCString <a href="#operator+"><b>operator+</b></a> ( const QCString & s1, const QCString & s2 )</li>
<li class=fn>const QCString <a href="#operator+-2"><b>operator+</b></a> ( const QCString & s1, const char * s2 )</li>
<li class=fn>const QCString <a href="#operator+-3"><b>operator+</b></a> ( const char * s1, const QCString & s2 )</li>
<li class=fn>const QCString <a href="#operator+-4"><b>operator+</b></a> ( const QCString & s, char c )</li>
<li class=fn>const QCString <a href="#operator+-5"><b>operator+</b></a> ( char c, const QCString & s )</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>
The QCString class provides an abstraction of the classic C
zero-terminated char array (char *).
<p>
<p> QCString inherits <a href="qbytearray.html">QByteArray</a>, which is defined as
<a href="qmemarray.html">QMemArray</a><char>. Since QCString is a QMemArray, it uses <a href="shclass.html">explicit sharing</a> with a reference count.
<p> QCString tries to behave like a more convenient <tt>const char *</tt>.
The price of doing this is that some algorithms will perform
badly. For example, <a href="#append">append</a>() is O(length()) since it scans for a
null terminator. Although you might use QCString for text that is
never exposed to the user, for most purposes, and especially for
user-visible text, you should use <a href="qstring.html">QString</a>. QString provides
<a href="shclass.html#implicit-sharing">implicit sharing</a>, Unicode and other <a href="i18n.html#internationalization">internationalization</a> support,
and is well optimized.
<p> Note that for the QCString methods that take a <tt>const char *</tt>
parameter the <tt>const char *</tt> must either be 0 (null) or not-null
and '\0' (NUL byte) terminated; otherwise the results are
undefined.
<p> A QCString that has not been assigned to anything is <em>null</em>, i.e.
both the length and the data pointer is 0. A QCString that
references the empty string ("", a single '\0' char) is <em>empty</em>.
Both null and empty QCStrings are legal parameters to the methods.
Assigning <tt>const char *</tt> 0 to QCString produces a null QCString.
<p> The <a href="#length">length</a>() function returns the length of the string; <a href="#resize">resize</a>()
resizes the string and <a href="#truncate">truncate</a>() truncates the string. A string
can be filled with a character using <a href="#fill">fill</a>(). Strings can be left
or right padded with characters using <a href="#leftJustify">leftJustify</a>() and
<a href="#rightJustify">rightJustify</a>(). Characters, strings and regular expressions can be
searched for using <a href="#find">find</a>() and <a href="#findRev">findRev</a>(), and counted using
<a href="#contains">contains</a>().
<p> Strings and characters can be inserted with <a href="#insert">insert</a>() and appended
with <a href="#append">append</a>(). A string can be prepended with <a href="#prepend">prepend</a>().
Characters can be removed from the string with <a href="#remove">remove</a>() and
replaced with <a href="#replace">replace</a>().
<p> Portions of a string can be extracted using <a href="#left">left</a>(), <a href="#right">right</a>() and
<a href="#mid">mid</a>(). Whitespace can be removed using <a href="#stripWhiteSpace">stripWhiteSpace</a>() and
<a href="#simplifyWhiteSpace">simplifyWhiteSpace</a>(). Strings can be converted to uppercase or
lowercase with <a href="#upper">upper</a>() and <a href="#lower">lower</a>() respectively.
<p> Strings that contain numbers can be converted to numbers with
<a href="#toShort">toShort</a>(), <a href="#toInt">toInt</a>(), <a href="#toLong">toLong</a>(), <a href="#toULong">toULong</a>(), <a href="#toFloat">toFloat</a>() and <a href="#toDouble">toDouble</a>().
Numbers can be converted to strings with <a href="#setNum">setNum</a>().
<p> Many operators are overloaded to work with QCStrings. QCString
also supports some more obscure functions, e.g. <a href="#sprintf">sprintf</a>(),
<a href="#setStr">setStr</a>() and <a href="#setExpand">setExpand</a>().
<p> <a name="asciinotion"></a>
<blockquote><p align="center"><b> Note on Character Comparisons
</b>
<p><p> In QCString the notion of uppercase and lowercase and of which
character is greater than or less than another character is locale
dependent. This affects functions which support a case insensitive
option or which compare or lowercase or uppercase their arguments.
Case insensitive operations and comparisons will be accurate if
both strings contain only ASCII characters. (If <tt>$LC_CTYPE</tt> is
set, most Unix systems do "the right thing".) Functions that this
affects include <a href="#contains">contains</a>(), <a href="#find">find</a>(), <a href="#findRev">findRev</a>(), <a href="#operator-lt">operator<</a>(), <a href="#operator-lt-eq">operator<=</a>(), <a href="#operator-gt">operator></a>(), <a href="#operator-gt-eq">operator>=</a>(), <a href="#lower">lower</a>() and
<a href="#upper">upper</a>().
<p> This issue does not apply to <a href="qstring.html">QString</a>s since they represent
characters using Unicode.
</blockquote>
<p>
<p> Performance note: The QCString methods for <a href="qregexp.html">QRegExp</a> searching are
implemented by converting the QCString to a <a href="qstring.html">QString</a> and performing
the search on that. This implies a <a href="shclass.html#deep-copy">deep copy</a> of the QCString data.
If you are going to perform many QRegExp searches on a large
QCString, you will get better performance by converting the
QCString to a QString yourself, and then searching in the QString.
<p>See also <a href="collection.html">Collection Classes</a>, <a href="shared.html">Implicitly and Explicitly Shared Classes</a>, <a href="text.html">Text Related Classes</a>, and <a href="tools.html">Non-GUI Classes</a>.
<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="QCString"></a>QCString::QCString ()
</h3>
<p> Constructs a null string.
<p> <p>See also <a href="#isNull">isNull</a>().
<h3 class=fn><a name="QCString-2"></a>QCString::QCString ( int size )
</h3>
Constructs a string with room for <em>size</em> characters, including
the '\0'-terminator. Makes a null string if <em>size</em> == 0.
<p> If <em>size</em> > 0, then the first and last characters in the string
are initialized to '\0'. All other characters are uninitialized.
<p> <p>See also <a href="#resize">resize</a>() and <a href="#isNull">isNull</a>().
<h3 class=fn><a name="QCString-3"></a>QCString::QCString ( const <a href="qcstring.html">QCString</a> & s )
</h3>
<p> Constructs a <a href="shclass.html#shallow-copy">shallow copy</a> <em>s</em>.
<p> <p>See also <a href="qmemarray.html#assign">assign</a>().
<h3 class=fn><a name="QCString-4"></a>QCString::QCString ( const char * str )
</h3>
Constructs a string that is a <a href="shclass.html#deep-copy">deep copy</a> of <em>str</em>.
<p> If <em>str</em> is 0 a null string is created.
<p> <p>See also <a href="#isNull">isNull</a>().
<h3 class=fn><a name="QCString-5"></a>QCString::QCString ( const char * str, uint maxsize )
</h3>
Constructs a string that is a <a href="shclass.html#deep-copy">deep copy</a> of <em>str</em>. The copy will
be at most <em>maxsize</em> bytes long including the '\0'-terminator.
<p> Example:
<pre>
QCString str( "helloworld", 6 ); // assigns "hello" to str
</pre>
<p> If <em>str</em> contains a 0 byte within the first <em>maxsize</em> bytes, the
resulting QCString will be terminated by this 0. If <em>str</em> is 0 a
null string is created.
<p> <p>See also <a href="#isNull">isNull</a>().
<h3 class=fn><a href="qcstring.html">QCString</a> & <a name="append"></a>QCString::append ( const char * str )
</h3>
<p> Appends string <em>str</em> to the string and returns a reference to the
string. Equivalent to <a href="#operator+-eq">operator+=</a>().
<h3 class=fn>int <a name="contains"></a>QCString::contains ( char c, bool cs = TRUE ) const
</h3>
Returns the number of times the character <em>c</em> occurs in the
string.
<p> The match is case sensitive if <em>cs</em> is TRUE, or case insensitive
if <em>cs</em> if FALSE.
<p> <p>See also <a href="#asciinotion">Note on character comparisons</a>.
<h3 class=fn>int <a name="contains-2"></a>QCString::contains ( const char * str, bool cs = TRUE ) const
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Returns the number of times <em>str</em> occurs in the string.
<p> The match is case sensitive if <em>cs</em> is TRUE, or case insensitive
if <em>cs</em> if FALSE.
<p> This function counts overlapping substrings, for example, "banana"
contains two occurrences of "ana".
<p> <p>See also <a href="#findRev">findRev</a>() and <a href="#asciinotion">Note on character comparisons</a>.
<h3 class=fn>int <a name="contains-3"></a>QCString::contains ( const <a href="qregexp.html">QRegExp</a> & rx ) const
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Counts the number of overlapping occurrences of <em>rx</em> in the string.
<p> Example:
<pre>
<a href="qstring.html">QString</a> s = "banana and panama";
<a href="qregexp.html">QRegExp</a> r = QRegExp( "a[nm]a", TRUE, FALSE );
s.<a href="qstring.html#contains">contains</a>( r ); // 4 matches
</pre>
<p> <p>See also <a href="#find">find</a>() and <a href="#findRev">findRev</a>().
<p> <b>Warning:</b> If you want to apply this function repeatedly to the same
string it is more efficient to convert the string to a <a href="qstring.html">QString</a> and
apply the function to that.
<h3 class=fn><a href="qcstring.html">QCString</a> <a name="copy"></a>QCString::copy () const
</h3>
<p> Returns a <a href="shclass.html#deep-copy">deep copy</a> of this string.
<p> <p>See also <a href="qmemarray.html#detach">detach</a>().
<h3 class=fn>bool <a name="fill"></a>QCString::fill ( char c, int len = -1 )
</h3>
Fills the string with <em>len</em> bytes of character <em>c</em>, followed by
a '\0'-terminator.
<p> If <em>len</em> is negative, then the current string length is used.
<p> Returns FALSE is <em>len</em> is nonnegative and there is not enough
memory to resize the string; otherwise returns TRUE.
<h3 class=fn>int <a name="find"></a>QCString::find ( char c, int index = 0, bool cs = TRUE ) const
</h3>
Finds the first occurrence of the character <em>c</em>, starting at
position <em>index</em>.
<p> The search is case sensitive if <em>cs</em> is TRUE, or case insensitive
if <em>cs</em> is FALSE.
<p> Returns the position of <em>c</em>, or -1 if <em>c</em> could not be found.
<p> <p>See also <a href="#asciinotion">Note on character comparisons</a>.
<p>Example: <a href="networkprotocol-example.html#x663">network/networkprotocol/nntp.cpp</a>.
<h3 class=fn>int <a name="find-2"></a>QCString::find ( const char * str, int index = 0, bool cs = TRUE ) const
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Finds the first occurrence of the string <em>str</em>, starting at
position <em>index</em>.
<p> The search is case sensitive if <em>cs</em> is TRUE, or case insensitive
if <em>cs</em> is FALSE.
<p> Returns the position of <em>str</em>, or -1 if <em>str</em> could not be
found.
<p> <p>See also <a href="#asciinotion">Note on character comparisons</a>.
<h3 class=fn>int <a name="find-3"></a>QCString::find ( const <a href="qregexp.html">QRegExp</a> & rx, int index = 0 ) const
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Finds the first occurrence of the <a href="qregexp.html#regular-expression">regular expression</a> <em>rx</em>,
starting at position <em>index</em>.
<p> Returns the position of the next match, or -1 if <em>rx</em> was not
found.
<p> <b>Warning:</b> If you want to apply this function repeatedly to the same
string it is more efficient to convert the string to a <a href="qstring.html">QString</a> and
apply the function to that.
<h3 class=fn>int <a name="findRev"></a>QCString::findRev ( char c, int index = -1, bool cs = TRUE ) const
</h3>
Finds the first occurrence of the character <em>c</em>, starting at
position <em>index</em> and searching backwards.
<p> The search is case sensitive if <em>cs</em> is TRUE, or case insensitive
if <em>cs</em> is FALSE.
<p> Returns the position of <em>c</em>, or -1 if <em>c</em> could not be found.
<p> <p>See also <a href="#asciinotion">Note on character comparisons</a>.
<h3 class=fn>int <a name="findRev-2"></a>QCString::findRev ( const char * str, int index = -1, bool cs = TRUE ) const
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Finds the first occurrence of the string <em>str</em>, starting at
position <em>index</em> and searching backwards.
<p> The search is case sensitive if <em>cs</em> is TRUE, or case insensitive
if <em>cs</em> is FALSE.
<p> Returns the position of <em>str</em>, or -1 if <em>str</em> could not be
found.
<p> <p>See also <a href="#asciinotion">Note on character comparisons</a>.
<h3 class=fn>int <a name="findRev-3"></a>QCString::findRev ( const <a href="qregexp.html">QRegExp</a> & rx, int index = -1 ) const
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Finds the first occurrence of the <a href="qregexp.html#regular-expression">regular expression</a> <em>rx</em>,
starting at position <em>index</em> and searching backwards.
<p> Returns the position of the next match (backwards), or -1 if <em>rx</em>
was not found.
<p> <b>Warning:</b> If you want to apply this function repeatedly to the same
string it is more efficient to convert the string to a <a href="qstring.html">QString</a> and
apply the function to that.
<h3 class=fn><a href="qcstring.html">QCString</a> & <a name="insert"></a>QCString::insert ( uint index, char c )
</h3>
Inserts character <em>c</em> into the string at position <em>index</em> and
returns a reference to the string.
<p> If <em>index</em> is beyond the end of the string, the string is
padded with spaces (ASCII 32) to length <em>index</em> and then <em>c</em>
is appended.
<p> Example:
<pre>
QCString s = "Yes";
s.<a href="#insert">insert</a>( 3, '!'); // s == "Yes!"
</pre>
<p> <p>See also <a href="#remove">remove</a>() and <a href="#replace">replace</a>().
<h3 class=fn><a href="qcstring.html">QCString</a> & <a name="insert-2"></a>QCString::insert ( uint index, const char * s )
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Inserts string <em>s</em> into the string at position <em>index</em>.
<p> If <em>index</em> is beyond the end of the string, the string is
padded with spaces (ASCII 32) to length <em>index</em> and then <em>s</em>
is appended.
<p> <pre>
QCString s = "I like fish";
s.<a href="#insert">insert</a>( 2, "don't "); // s == "I don't like fish"
s = "x"; // index 01234
s.<a href="#insert">insert</a>( 3, "yz" ); // s == "x yz"
</pre>
<h3 class=fn>bool <a name="isEmpty"></a>QCString::isEmpty () const
</h3>
<p> Returns TRUE if the string is empty, i.e. if <a href="#length">length</a>() == 0;
otherwise returns FALSE. An empty string is not always a null
string.
<p> See example in <a href="#isNull">isNull</a>().
<p> <p>See also <a href="#isNull">isNull</a>(), <a href="#length">length</a>(), and <a href="qmemarray.html#size">size</a>().
<h3 class=fn>bool <a name="isNull"></a>QCString::isNull () const
</h3>
<p> Returns TRUE if the string is null, i.e. if <a href="qmemarray.html#data">data</a>() == 0; otherwise
returns FALSE. A null string is also an empty string.
<p> Example:
<pre>
QCString a; // a.<a href="qmemarray.html#data">data</a>() == 0, a.<a href="qmemarray.html#size">size</a>() == 0, a.<a href="#length">length</a>() == 0
QCString b == ""; // b.<a href="qmemarray.html#data">data</a>() == "", b.<a href="qmemarray.html#size">size</a>() == 1, b.<a href="#length">length</a>() == 0
a.<a href="#isNull">isNull</a>(); // TRUE because a.<a href="qmemarray.html#data">data</a>() == 0
a.<a href="#isEmpty">isEmpty</a>(); // TRUE because a.<a href="#length">length</a>() == 0
b.<a href="#isNull">isNull</a>(); // FALSE because b.<a href="qmemarray.html#data">data</a>() == ""
b.<a href="#isEmpty">isEmpty</a>(); // TRUE because b.<a href="#length">length</a>() == 0
</pre>
<p> <p>See also <a href="#isEmpty">isEmpty</a>(), <a href="#length">length</a>(), and <a href="qmemarray.html#size">size</a>().
<h3 class=fn><a href="qcstring.html">QCString</a> <a name="left"></a>QCString::left ( uint len ) const
</h3>
Returns a substring that contains the <em>len</em> leftmost characters
of the string.
<p> The whole string is returned if <em>len</em> exceeds the length of the
string.
<p> Example:
<pre>
QCString s = "Pineapple";
QCString t = s.<a href="#left">left</a>( 4 ); // t == "Pine"
</pre>
<p> <p>See also <a href="#right">right</a>() and <a href="#mid">mid</a>().
<p>Example: <a href="networkprotocol-example.html#x664">network/networkprotocol/nntp.cpp</a>.
<h3 class=fn><a href="qcstring.html">QCString</a> <a name="leftJustify"></a>QCString::leftJustify ( uint width, char fill = ' ', bool truncate = FALSE ) const
</h3>
Returns a string of length <em>width</em> (plus one for the terminating
'\0') that contains this string padded with the <em>fill</em> character.
<p> If the length of the string exceeds <em>width</em> and <em>truncate</em> is
FALSE (the default), then the returned string is a copy of the
string. If the length of the string exceeds <em>width</em> and <em>truncate</em> is TRUE, then the returned string is a <a href="#left">left</a>(<em>width</em>).
<p> Example:
<pre>
QCString s("apple");
QCString t = s.<a href="#leftJustify">leftJustify</a>(8, '.'); // t == "apple..."
</pre>
<p> <p>See also <a href="#rightJustify">rightJustify</a>().
<h3 class=fn>uint <a name="length"></a>QCString::length () const
</h3>
<p> Returns the length of the string, excluding the '\0'-terminator.
Equivalent to calling <tt>strlen(data())</tt>.
<p> Null strings and empty strings have zero length.
<p> <p>See also <a href="qmemarray.html#size">size</a>(), <a href="#isNull">isNull</a>(), and <a href="#isEmpty">isEmpty</a>().
<p>Example: <a href="networkprotocol-example.html#x665">network/networkprotocol/nntp.cpp</a>.
<h3 class=fn><a href="qcstring.html">QCString</a> <a name="lower"></a>QCString::lower () const
</h3>
Returns a new string that is a copy of this string converted to lower
case.
<p> Example:
<pre>
QCString s("Credit");
QCString t = s.<a href="#lower">lower</a>(); // t == "credit"
</pre>
<p> <p>See also <a href="#upper">upper</a>() and <a href="#asciinotion">Note on character comparisons</a>.
<h3 class=fn><a href="qcstring.html">QCString</a> <a name="mid"></a>QCString::mid ( uint index, uint len = 0xffffffff ) const
</h3>
Returns a substring that contains at most <em>len</em> characters from
this string, starting at position <em>index</em>.
<p> Returns a null string if the string is empty or if <em>index</em> is out
of range. Returns the whole string from <em>index</em> if <em>index+len</em>
exceeds the length of the string.
<p> Example:
<pre>
QCString s = "Two pineapples";
QCString t = s.<a href="#mid">mid</a>( 4, 3 ); // t == "pin"
</pre>
<p> <p>See also <a href="#left">left</a>() and <a href="#right">right</a>().
<p>Example: <a href="networkprotocol-example.html#x666">network/networkprotocol/nntp.cpp</a>.
<h3 class=fn><a name="operator-const-char-*"></a>QCString::operator const char * () const
</h3>
<p> Returns the string data.
<h3 class=fn><a href="qcstring.html">QCString</a> & <a name="operator+-eq"></a>QCString::operator+= ( const char * str )
</h3>
Appends string <em>str</em> to the string and returns a reference to the string.
<h3 class=fn><a href="qcstring.html">QCString</a> & <a name="operator+-eq-2"></a>QCString::operator+= ( char c )
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Appends character <em>c</em> to the string and returns a reference to the string.
<h3 class=fn><a href="qcstring.html">QCString</a> & <a name="operator-eq"></a>QCString::operator= ( const <a href="qcstring.html">QCString</a> & s )
</h3>
<p> Assigns a <a href="shclass.html#shallow-copy">shallow copy</a> of <em>s</em> to this string and returns a
reference to this string.
<h3 class=fn><a href="qcstring.html">QCString</a> & <a name="operator-eq-2"></a>QCString::operator= ( const char * str )
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Assigns a <a href="shclass.html#deep-copy">deep copy</a> of <em>str</em> to this string and returns a
reference to this string.
<p> If <em>str</em> is 0 a null string is created.
<p> <p>See also <a href="#isNull">isNull</a>().
<h3 class=fn><a href="qcstring.html">QCString</a> & <a name="prepend"></a>QCString::prepend ( const char * s )
</h3>
<p> Prepend <em>s</em> to the string. Equivalent to <a href="#insert">insert</a>(0, s).
<p> <p>See also <a href="#insert">insert</a>().
<h3 class=fn><a href="qcstring.html">QCString</a> & <a name="remove"></a>QCString::remove ( uint index, uint len )
</h3>
Removes <em>len</em> characters from the string, starting at position <em>index</em>, and returns a reference to the string.
<p> If <em>index</em> is out of range, nothing happens. If <em>index</em> is
valid, but <em>index</em> + <em>len</em> is larger than the length of the
string, the string is truncated at position <em>index</em>.
<p> <pre>
QCString s = "Montreal";
s.<a href="#remove">remove</a>( 1, 4 ); // s == "Meal"
</pre>
<p> <p>See also <a href="#insert">insert</a>() and <a href="#replace">replace</a>().
<p>Example: <a href="networkprotocol-example.html#x667">network/networkprotocol/nntp.cpp</a>.
<h3 class=fn><a href="qcstring.html">QCString</a> & <a name="replace"></a>QCString::replace ( uint index, uint len, const char * str )
</h3>
Replaces <em>len</em> characters from the string, starting at position
<em>index</em>, with <em>str</em>, and returns a reference to the string.
<p> If <em>index</em> is out of range, nothing is removed and <em>str</em> is
appended at the end of the string. If <em>index</em> is valid, but <em>index</em> + <em>len</em> is larger than the length of the string, <em>str</em>
replaces the rest of the string from position <em>index</em>.
<p> <pre>
QCString s = "Say yes!";
s.<a href="#replace">replace</a>( 4, 3, "NO" ); // s == "Say NO!"
</pre>
<p> <p>See also <a href="#insert">insert</a>() and <a href="#remove">remove</a>().
<h3 class=fn><a href="qcstring.html">QCString</a> & <a name="replace-2"></a>QCString::replace ( const <a href="qregexp.html">QRegExp</a> & rx, const char * str )
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Replaces every occurrence of <em>rx</em> in the string with <em>str</em>.
Returns a reference to the string.
<p> Example:
<pre>
<a href="qstring.html">QString</a> s = "banana";
s.<a href="qstring.html#replace">replace</a>( QRegExp("a.*a"), "" ); // becomes "b"
s = "banana";
s.<a href="qstring.html#replace">replace</a>( QRegExp("^[bn]a"), "X" ); // becomes "Xnana"
s = "banana";
s.<a href="qstring.html#replace">replace</a>( QRegExp("^[bn]a"), "" ); // becomes "nana"
</pre>
<p> <b>Warning:</b> If you want to apply this function repeatedly to the same
string it is more efficient to convert the string to a <a href="qstring.html">QString</a> and
apply the function to that.
<h3 class=fn><a href="qcstring.html">QCString</a> & <a name="replace-3"></a>QCString::replace ( char c, const char * after )
</h3> This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Replaces every occurrence of the character <em>c</em> in the string
with <em>after</em>. Returns a reference to the string.
<p> Example:
<pre>
QCString s = "a,b,c";
s.<a href="#replace">replace</a>( ',', " or " );
// s == "a or b or c"
</pre>
<h3 class=fn><a href="qcstring.html">QCString</a> & <a name="replace-4"></a>QCString::replace ( const char * before, const char * after )
</h3> This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Replaces every occurrence of the string <em>before</em> in the string
with the string <em>after</em>. Returns a reference to the string.
<p> Example:
<pre>
QCString s = "Greek is Greek";
s.<a href="#replace">replace</a>( "Greek", "English" );
// s == "English is English"
</pre>
<h3 class=fn><a href="qcstring.html">QCString</a> & <a name="replace-5"></a>QCString::replace ( char c1, char c2 )
</h3> This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Replaces every occurrence of <em>c1</em> with the char <em>c2</em>.
Returns a reference to the string.
<h3 class=fn>bool <a name="resize"></a>QCString::resize ( uint len )
</h3>
Extends or shrinks the string to <em>len</em> bytes, including the
'\0'-terminator.
<p> A '\0'-terminator is set at position <tt>len - 1</tt> unless
<tt>len == 0</tt>.
<p> Example:
<pre>
QCString s = "resize this string";
s.<a href="#resize">resize</a>( 7 ); // s == "resize"
</pre>
<p> <p>See also <a href="#truncate">truncate</a>().
<p>Example: <a href="networkprotocol-example.html#x668">network/networkprotocol/nntp.cpp</a>.
<h3 class=fn><a href="qcstring.html">QCString</a> <a name="right"></a>QCString::right ( uint len ) const
</h3>
Returns a substring that contains the <em>len</em> rightmost characters
of the string.
<p> The whole string is returned if <em>len</em> exceeds the length of the
string.
<p> Example:
<pre>
QCString s = "Pineapple";
QCString t = s.<a href="#right">right</a>( 5 ); // t == "apple"
</pre>
<p> <p>See also <a href="#left">left</a>() and <a href="#mid">mid</a>().
<p>Example: <a href="networkprotocol-example.html#x669">network/networkprotocol/nntp.cpp</a>.
<h3 class=fn><a href="qcstring.html">QCString</a> <a name="rightJustify"></a>QCString::rightJustify ( uint width, char fill = ' ', bool truncate = FALSE ) const
</h3>
Returns a string of length <em>width</em> (plus one for the terminating
'\0') that contains zero or more of the <em>fill</em> character followed
by this string.
<p> If the length of the string exceeds <em>width</em> and <em>truncate</em> is
FALSE (the default), then the returned string is a copy of the
string. If the length of the string exceeds <em>width</em> and <em>truncate</em> is TRUE, then the returned string is a <a href="#left">left</a>(<em>width</em>).
<p> Example:
<pre>
QCString s("pie");
QCString t = s.<a href="#rightJustify">rightJustify</a>(8, '.'); // t == ".....pie"
</pre>
<p> <p>See also <a href="#leftJustify">leftJustify</a>().
<h3 class=fn>bool <a name="setExpand"></a>QCString::setExpand ( uint index, char c )
</h3>
Sets the character at position <em>index</em> to <em>c</em> and expands the
string if necessary, padding with spaces.
<p> Returns FALSE if <em>index</em> was out of range and the string could
not be expanded; otherwise returns TRUE.
<h3 class=fn><a href="qcstring.html">QCString</a> & <a name="setNum"></a>QCString::setNum ( double n, char f = 'g', int prec = 6 )
</h3>
Sets the string to the string representation of the number <em>n</em>
and returns a reference to the string.
<p> The format of the string representation is specified by the format
character <em>f</em>, and the precision (number of digits after the
decimal point) is specified with <em>prec</em>.
<p> The valid formats for <em>f</em> are 'e', 'E', 'f', 'g' and 'G'. The
formats are the same as for <a href="#sprintf">sprintf</a>(); they are explained in <a href="qstring.html#arg">QString::arg</a>().
<h3 class=fn><a href="qcstring.html">QCString</a> & <a name="setNum-2"></a>QCString::setNum ( short n )
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Sets the string to the string representation of the number <em>n</em>
and returns a reference to the string.
<h3 class=fn><a href="qcstring.html">QCString</a> & <a name="setNum-3"></a>QCString::setNum ( ushort n )
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Sets the string to the string representation of the number <em>n</em>
and returns a reference to the string.
<h3 class=fn><a href="qcstring.html">QCString</a> & <a name="setNum-4"></a>QCString::setNum ( int n )
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Sets the string to the string representation of the number <em>n</em>
and returns a reference to the string.
<h3 class=fn><a href="qcstring.html">QCString</a> & <a name="setNum-5"></a>QCString::setNum ( uint n )
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Sets the string to the string representation of the number <em>n</em>
and returns a reference to the string.
<h3 class=fn><a href="qcstring.html">QCString</a> & <a name="setNum-6"></a>QCString::setNum ( long n )
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Sets the string to the string representation of the number <em>n</em>
and returns a reference to the string.
<h3 class=fn><a href="qcstring.html">QCString</a> & <a name="setNum-7"></a>QCString::setNum ( ulong n )
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Sets the string to the string representation of the number <em>n</em>
and returns a reference to the string.
<h3 class=fn><a href="qcstring.html">QCString</a> & <a name="setNum-8"></a>QCString::setNum ( float n, char f = 'g', int prec = 6 )
</h3> This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<h3 class=fn><a href="qcstring.html">QCString</a> & <a name="setStr"></a>QCString::setStr ( const char * str )
</h3>
Makes a <a href="shclass.html#deep-copy">deep copy</a> of <em>str</em>. Returns a reference to the string.
<h3 class=fn><a href="qcstring.html">QCString</a> <a name="simplifyWhiteSpace"></a>QCString::simplifyWhiteSpace () const
</h3>
Returns a new string that has white space removed from the start
and the end, plus any sequence of internal white space replaced
with a single space (ASCII 32).
<p> White space means the decimal ASCII codes 9, 10, 11, 12, 13 and
32.
<p> <pre>
QCString s = " lots\t of\nwhite space ";
QCString t = s.<a href="#simplifyWhiteSpace">simplifyWhiteSpace</a>(); // t == "lots of white space"
</pre>
<p> <p>See also <a href="#stripWhiteSpace">stripWhiteSpace</a>().
<h3 class=fn><a href="qcstring.html">QCString</a> & <a name="sprintf"></a>QCString::sprintf ( const char * format, ... )
</h3>
Implemented as a call to the native vsprintf() (see the manual for
your C library).
<p> If the string is shorter than 256 characters, this <a href="#sprintf">sprintf</a>() calls
<a href="#resize">resize</a>(256) to decrease the chance of memory corruption. The
string is resized back to its actual length before sprintf()
returns.
<p> Example:
<pre>
QCString s;
s.<a href="#sprintf">sprintf</a>( "%d - %s", 1, "first" ); // result < 256 chars
QCString big( 25000 ); // very long string
big.<a href="#sprintf">sprintf</a>( "%d - %s", 2, longString ); // result < 25000 chars
</pre>
<p> <b>Warning:</b> All vsprintf() implementations will write past the end of
the target string (*this) if the <em>format</em> specification and
arguments happen to be longer than the target string, and some
will also fail if the target string is longer than some arbitrary
implementation limit.
<p> Giving user-supplied arguments to sprintf() is risky: Sooner or
later someone will paste a huge line into your application.
<h3 class=fn><a href="qcstring.html">QCString</a> <a name="stripWhiteSpace"></a>QCString::stripWhiteSpace () const
</h3>
Returns a new string that has white space removed from the start
and the end.
<p> White space means the decimal ASCII codes 9, 10, 11, 12, 13 and
32.
<p> Example:
<pre>
QCString s = " space ";
QCString t = s.<a href="#stripWhiteSpace">stripWhiteSpace</a>(); // t == "space"
</pre>
<p> <p>See also <a href="#simplifyWhiteSpace">simplifyWhiteSpace</a>().
<h3 class=fn>double <a name="toDouble"></a>QCString::toDouble ( bool * ok = 0 ) const
</h3>
Returns the string converted to a <tt>double</tt> value.
<p> If <em>ok</em> is not 0: <em>*ok</em> is set to FALSE if the string is not a
number, or if it has trailing garbage; otherwise <em>*ok</em> is set to
TRUE.
<h3 class=fn>float <a name="toFloat"></a>QCString::toFloat ( bool * ok = 0 ) const
</h3>
Returns the string converted to a <tt>float</tt> value.
<p> If <em>ok</em> is not 0: <em>*ok</em> is set to FALSE if the string is not a
number, or if it has trailing garbage; otherwise <em>*ok</em> is set to
TRUE.
<h3 class=fn>int <a name="toInt"></a>QCString::toInt ( bool * ok = 0 ) const
</h3>
Returns the string converted to a <tt>int</tt> value.
<p> If <em>ok</em> is not 0: <em>*ok</em> is set to FALSE if the string is not a
number, or if it has trailing garbage; otherwise <em>*ok</em> is set to
TRUE.
<h3 class=fn>long <a name="toLong"></a>QCString::toLong ( bool * ok = 0 ) const
</h3>
Returns the string converted to a <tt>long</tt> value.
<p> If <em>ok</em> is not 0: <em>*ok</em> is set to FALSE if the string is not a
number, or if it has trailing garbage; otherwise <em>*ok</em> is set to
TRUE.
<h3 class=fn>short <a name="toShort"></a>QCString::toShort ( bool * ok = 0 ) const
</h3>
Returns the string converted to a <tt>short</tt> value.
<p> If <em>ok</em> is not 0: <em>*ok</em> is set to FALSE if the string is not a
number, is out of range, or if it has trailing garbage; otherwise
<em>*ok</em> is set to TRUE.
<h3 class=fn>uint <a name="toUInt"></a>QCString::toUInt ( bool * ok = 0 ) const
</h3>
Returns the string converted to an <tt>unsigned int</tt> value.
<p> If <em>ok</em> is not 0: <em>*ok</em> is set to FALSE if the string is not a
number, or if it has trailing garbage; otherwise <em>*ok</em> is set to
TRUE.
<h3 class=fn>ulong <a name="toULong"></a>QCString::toULong ( bool * ok = 0 ) const
</h3>
Returns the string converted to an <tt>unsigned long</tt> value.
<p> If <em>ok</em> is not 0: <em>*ok</em> is set to FALSE if the string is not a
number, or if it has trailing garbage; otherwise <em>*ok</em> is set to
TRUE.
<h3 class=fn>ushort <a name="toUShort"></a>QCString::toUShort ( bool * ok = 0 ) const
</h3>
Returns the string converted to an <tt>unsigned short</tt> value.
<p> If <em>ok</em> is not 0: <em>*ok</em> is set to FALSE if the string is not a
number, is out of range, or if it has trailing garbage; otherwise
<em>*ok</em> is set to TRUE.
<h3 class=fn>bool <a name="truncate"></a>QCString::truncate ( uint pos )
</h3>
<p> Truncates the string at position <em>pos</em>.
<p> Equivalent to calling <tt>resize(pos+1)</tt>.
<p> Example:
<pre>
QCString s = "truncate this string";
s.<a href="#truncate">truncate</a>( 5 ); // s == "trunc"
</pre>
<p> <p>See also <a href="#resize">resize</a>().
<h3 class=fn><a href="qcstring.html">QCString</a> <a name="upper"></a>QCString::upper () const
</h3>
Returns a new string that is a copy of this string converted to upper case.
<p> Example:
<pre>
QCString s( "Debit" );
QCString t = s.<a href="#upper">upper</a>(); // t == "DEBIT"
</pre>
<p> <p>See also <a href="#lower">lower</a>() and <a href="#asciinotion">Note on character comparisons</a>.
<hr><h2>Related Functions</h2>
<h3 class=fn>bool <a name="operator!-eq"></a>operator!= ( const <a href="qcstring.html">QCString</a> & s1, const <a href="qcstring.html">QCString</a> & s2 )
</h3>
<p>
<p> Returns TRUE if <em>s1</em> and <em>s2</em> are different; otherwise returns FALSE.
<p> Equivalent to <a href="#qstrcmp">qstrcmp</a>(<em>s1</em>, <em>s2</em>) != 0.
<h3 class=fn>bool <a name="operator!-eq-2"></a>operator!= ( const <a href="qcstring.html">QCString</a> & s1, const char * s2 )
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p>
<p> Returns TRUE if <em>s1</em> and <em>s2</em> are different; otherwise returns FALSE.
<p> Equivalent to <a href="#qstrcmp">qstrcmp</a>(<em>s1</em>, <em>s2</em>) != 0.
<h3 class=fn>bool <a name="operator!-eq-3"></a>operator!= ( const char * s1, const <a href="qcstring.html">QCString</a> & s2 )
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p>
<p> Returns TRUE if <em>s1</em> and <em>s2</em> are different; otherwise returns FALSE.
<p> Equivalent to <a href="#qstrcmp">qstrcmp</a>(<em>s1</em>, <em>s2</em>) != 0.
<h3 class=fn>const <a href="qcstring.html">QCString</a> <a name="operator+"></a>operator+ ( const <a href="qcstring.html">QCString</a> & s1, const <a href="qcstring.html">QCString</a> & s2 )
</h3>
<p>
<p> Returns a string which consists of the concatenation of <em>s1</em> and
<em>s2</em>.
<h3 class=fn>const <a href="qcstring.html">QCString</a> <a name="operator+-2"></a>operator+ ( const <a href="qcstring.html">QCString</a> & s1, const char * s2 )
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p>
<p> Returns a string which consists of the concatenation of <em>s1</em> and <em>s2</em>.
<h3 class=fn>const <a href="qcstring.html">QCString</a> <a name="operator+-3"></a>operator+ ( const char * s1, const <a href="qcstring.html">QCString</a> & s2 )
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p>
<p> Returns a string which consists of the concatenation of <em>s1</em> and <em>s2</em>.
<h3 class=fn>const <a href="qcstring.html">QCString</a> <a name="operator+-4"></a>operator+ ( const <a href="qcstring.html">QCString</a> & s, char c )
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p>
<p> Returns a string which consists of the concatenation of <em>s</em> and <em>c</em>.
<h3 class=fn>const <a href="qcstring.html">QCString</a> <a name="operator+-5"></a>operator+ ( char c, const <a href="qcstring.html">QCString</a> & s )
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p>
<p> Returns a string which consists of the concatenation of <em>c</em> and <em>s</em>.
<h3 class=fn>bool <a name="operator-lt"></a>operator< ( const <a href="qcstring.html">QCString</a> & s1, const char * s2 )
</h3>
<p>
<p> Returns TRUE if <em>s1</em> is less than <em>s2</em>; otherwise returns FALSE.
<p> Equivalent to <a href="#qstrcmp">qstrcmp</a>(<em>s1</em>, <em>s2</em>) < 0.
<p> <p>See also <a href="#asciinotion">Note on character comparisons</a>.
<h3 class=fn>bool <a name="operator-lt-2"></a>operator< ( const char * s1, const <a href="qcstring.html">QCString</a> & s2 )
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p>
<p> Returns TRUE if <em>s1</em> is less than <em>s2</em>; otherwise returns FALSE.
<p> Equivalent to <a href="#qstrcmp">qstrcmp</a>(<em>s1</em>, <em>s2</em>) < 0.
<p> <p>See also <a href="#asciinotion">Note on character comparisons</a>.
<h3 class=fn><a href="qdatastream.html">QDataStream</a> & <a name="operator-lt-lt"></a>operator<< ( <a href="qdatastream.html">QDataStream</a> & s, const <a href="qcstring.html">QCString</a> & str )
</h3>
<p> Writes string <em>str</em> to the stream <em>s</em>.
<p> <p>See also <a href="datastreamformat.html">Format of the QDataStream operators</a>.
<h3 class=fn>bool <a name="operator-lt-eq"></a>operator<= ( const <a href="qcstring.html">QCString</a> & s1, const char * s2 )
</h3>
<p>
<p> Returns TRUE if <em>s1</em> is less than or equal to <em>s2</em>; otherwise
returns FALSE.
<p> Equivalent to <a href="#qstrcmp">qstrcmp</a>(<em>s1</em>, <em>s2</em>) <= 0.
<p> <p>See also <a href="#asciinotion">Note on character comparisons</a>.
<h3 class=fn>bool <a name="operator-lt-eq-2"></a>operator<= ( const char * s1, const <a href="qcstring.html">QCString</a> & s2 )
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p>
<p> Returns TRUE if <em>s1</em> is less than or equal to <em>s2</em>; otherwise
returns FALSE.
<p> Equivalent to <a href="#qstrcmp">qstrcmp</a>(<em>s1</em>, <em>s2</em>) <= 0.
<p> <p>See also <a href="#asciinotion">Note on character comparisons</a>.
<h3 class=fn>bool <a name="operator-eq-eq"></a>operator== ( const <a href="qcstring.html">QCString</a> & s1, const <a href="qcstring.html">QCString</a> & s2 )
</h3>
<p>
<p> Returns TRUE if <em>s1</em> and <em>s2</em> are equal; otherwise returns FALSE.
<p> Equivalent to <a href="#qstrcmp">qstrcmp</a>(<em>s1</em>, <em>s2</em>) == 0.
<h3 class=fn>bool <a name="operator-eq-eq-2"></a>operator== ( const <a href="qcstring.html">QCString</a> & s1, const char * s2 )
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p>
<p> Returns TRUE if <em>s1</em> and <em>s2</em> are equal; otherwise returns FALSE.
<p> Equivalent to <a href="#qstrcmp">qstrcmp</a>(<em>s1</em>, <em>s2</em>) == 0.
<h3 class=fn>bool <a name="operator-eq-eq-3"></a>operator== ( const char * s1, const <a href="qcstring.html">QCString</a> & s2 )
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p>
<p> Returns TRUE if <em>s1</em> and <em>s2</em> are equal; otherwise returns FALSE.
<p> Equivalent to <a href="#qstrcmp">qstrcmp</a>(<em>s1</em>, <em>s2</em>) == 0.
<h3 class=fn>bool <a name="operator-gt"></a>operator> ( const <a href="qcstring.html">QCString</a> & s1, const char * s2 )
</h3>
<p>
<p> Returns TRUE if <em>s1</em> is greater than <em>s2</em>; otherwise returns FALSE.
<p> Equivalent to <a href="#qstrcmp">qstrcmp</a>(<em>s1</em>, <em>s2</em>) > 0.
<p> <p>See also <a href="#asciinotion">Note on character comparisons</a>.
<h3 class=fn>bool <a name="operator-gt-2"></a>operator> ( const char * s1, const <a href="qcstring.html">QCString</a> & s2 )
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p>
<p> Returns TRUE if <em>s1</em> is greater than <em>s2</em>; otherwise returns FALSE.
<p> Equivalent to <a href="#qstrcmp">qstrcmp</a>(<em>s1</em>, <em>s2</em>) > 0.
<p> <p>See also <a href="#asciinotion">Note on character comparisons</a>.
<h3 class=fn>bool <a name="operator-gt-eq"></a>operator>= ( const <a href="qcstring.html">QCString</a> & s1, const char * s2 )
</h3>
<p>
<p> Returns TRUE if <em>s1</em> is greater than or equal to <em>s2</em>; otherwise
returns FALSE.
<p> Equivalent to <a href="#qstrcmp">qstrcmp</a>(<em>s1</em>, <em>s2</em>) >= 0.
<p> <p>See also <a href="#asciinotion">Note on character comparisons</a>.
<h3 class=fn>bool <a name="operator-gt-eq-2"></a>operator>= ( const char * s1, const <a href="qcstring.html">QCString</a> & s2 )
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p>
<p> Returns TRUE if <em>s1</em> is greater than or equal to <em>s2</em>; otherwise
returns FALSE.
<p> Equivalent to <a href="#qstrcmp">qstrcmp</a>(<em>s1</em>, <em>s2</em>) >= 0.
<p> <p>See also <a href="#asciinotion">Note on character comparisons</a>.
<h3 class=fn><a href="qdatastream.html">QDataStream</a> & <a name="operator-gt-gt"></a>operator>> ( <a href="qdatastream.html">QDataStream</a> & s, <a href="qcstring.html">QCString</a> & str )
</h3>
<p> Reads a string into <em>str</em> from the stream <em>s</em>.
<p> <p>See also <a href="datastreamformat.html">Format of the QDataStream operators</a>.
<h3 class=fn>void * <a name="qmemmove"></a>qmemmove ( void * dst, const void * src, uint len )
</h3>
<p> This function is normally part of the C library. Qt implements
memmove() for platforms that do not provide it.
<p> memmove() copies <em>len</em> bytes from <em>src</em> into <em>dst</em>. The data
is copied correctly even if <em>src</em> and <em>dst</em> overlap.
<h3 class=fn>int <a name="qstrcmp"></a>qstrcmp ( const char * str1, const char * str2 )
</h3>
<p>
<p> A safe strcmp() function.
<p> Compares <em>str1</em> and <em>str2</em>. Returns a negative value if <em>str1</em>
is less than <em>str2</em>, 0 if <em>str1</em> is equal to <em>str2</em> or a
positive value if <em>str1</em> is greater than <em>str2</em>.
<p> Special case I: Returns 0 if <em>str1</em> and <em>str2</em> are both 0.
<p> Special case II: Returns a random nonzero value if <em>str1</em> is 0
or <em>str2</em> is 0 (but not both).
<p> <p>See also <a href="#qstrncmp">qstrncmp</a>(), <a href="#qstricmp">qstricmp</a>(), <a href="#qstrnicmp">qstrnicmp</a>(), and <a href="#asciinotion">Note on character comparisons</a>.
<h3 class=fn>char * <a name="qstrcpy"></a>qstrcpy ( char * dst, const char * src )
</h3>
<p>
<p> A safe strcpy() function.
<p> Copies all characters up to and including the '\0' from <em>src</em>
into <em>dst</em> and returns a pointer to <em>dst</em>.
<h3 class=fn>char * <a name="qstrdup"></a>qstrdup ( const char * src )
</h3>
<p> Returns a duplicate string.
<p> Allocates space for a copy of <em>src</em>, copies it, and returns a
pointer to the copy. If <em>src</em> is 0, it immediately returns 0.
<p> The returned string must be deleted using <tt>delete[]</tt>.
<h3 class=fn>int <a name="qstricmp"></a>qstricmp ( const char * str1, const char * str2 )
</h3>
<p> A safe stricmp() function.
<p> Compares <em>str1</em> and <em>str2</em> ignoring the case.
<p> Returns a negative value if <em>str1</em> is less than <em>str2</em>, 0 if <em>str1</em> is equal to <em>str2</em> or a positive value if <em>str1</em> is greater
than <em>str2</em>.
<p> Special case I: Returns 0 if <em>str1</em> and <em>str2</em> are both 0.
<p> Special case II: Returns a random nonzero value if <em>str1</em> is 0
or <em>str2</em> is 0 (but not both).
<p> <p>See also <a href="#qstrcmp">qstrcmp</a>(), <a href="#qstrncmp">qstrncmp</a>(), <a href="#qstrnicmp">qstrnicmp</a>(), and <a href="#asciinotion">Note on character comparisons</a>.
<h3 class=fn>uint <a name="qstrlen"></a>qstrlen ( const char * str )
</h3>
<p>
<p> A safe strlen function.
<p> Returns the number of characters that precede the terminating '\0'.
or 0 if <em>str</em> is 0.
<h3 class=fn>int <a name="qstrncmp"></a>qstrncmp ( const char * str1, const char * str2, uint len )
</h3>
<p>
<p> A safe strncmp() function.
<p> Compares at most <em>len</em> bytes of <em>str1</em> and <em>str2</em>.
<p> Returns a negative value if <em>str1</em> is less than <em>str2</em>, 0 if <em>str1</em> is equal to <em>str2</em> or a positive value if <em>str1</em> is greater
than <em>str2</em>.
<p> Special case I: Returns 0 if <em>str1</em> and <em>str2</em> are both 0.
<p> Special case II: Returns a random nonzero value if <em>str1</em> is 0
or <em>str2</em> is 0 (but not both).
<p> <p>See also <a href="#qstrcmp">qstrcmp</a>(), <a href="#qstricmp">qstricmp</a>(), <a href="#qstrnicmp">qstrnicmp</a>(), and <a href="#asciinotion">Note on character comparisons</a>.
<h3 class=fn>char * <a name="qstrncpy"></a>qstrncpy ( char * dst, const char * src, uint len )
</h3>
<p> A safe strncpy() function.
<p> Copies at most <em>len</em> bytes from <em>src</em> (stopping at <em>len</em> or the
terminating '\0' whichever comes first) into <em>dst</em> and returns a
pointer to <em>dst</em>. Guarantees that <em>dst</em> is '\0'-terminated. If
<em>src</em> or <em>dst</em> is 0, returns 0 immediately.
<p> <p>See also <a href="#qstrcpy">qstrcpy</a>().
<h3 class=fn>int <a name="qstrnicmp"></a>qstrnicmp ( const char * str1, const char * str2, uint len )
</h3>
<p> A safe strnicmp() function.
<p> Compares at most <em>len</em> bytes of <em>str1</em> and <em>str2</em> ignoring the case.
<p> Returns a negative value if <em>str1</em> is less than <em>str2</em>, 0 if <em>str1</em>
is equal to <em>str2</em> or a positive value if <em>str1</em> is greater than <em>str2</em>.
<p> Special case I: Returns 0 if <em>str1</em> and <em>str2</em> are both 0.
<p> Special case II: Returns a random nonzero value if <em>str1</em> is 0
or <em>str2</em> is 0 (but not both).
<p> <p>See also <a href="#qstrcmp">qstrcmp</a>(), <a href="#qstrncmp">qstrncmp</a>(), <a href="#qstricmp">qstricmp</a>(), and <a href="#asciinotion">Note on character comparisons</a>.
<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">Qt toolkit</a>.
Copyright © 1995-2007
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright © 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>Qt 3.3.8</div>
</table></div></address></body>
</html>
|