<HTML>
<STYLE>
<!--
A{textdecoration:none}
-->
</STYLE>
<STYLE type="text/css">
A:link, A:visited, A:active { text-decoration: none; }
</STYLE>
<HEAD>
<TITLE>IDirectFBFont - GetStringBreak [DirectFB Reference Manual]</TITLE>
</HEAD>
<BODY bgcolor=#C0C8D8 link=#2369E0 vlink=#2369E0 text=#232323>
<TABLE width=100% bgcolor=#8090A0 border=0 cellspacing=0 cellpadding=5>
<TR><TD width=30%>
<A href="http://www.directfb.org"><IMG border=0 src="dfb_logo-alpha.png"></A>
</TD><TD align=right>
<A href="index.html"><FONT size=+3 color=#203040>Reference Manual - 1.7.5</FONT></A>
</TD></TR>
<TR><TD colspan=2 align=center bgcolor=#284460>
<TABLE border=0 cellspacing=0 cellpadding=0>
<TR><TD nowrap align=right width=50%>
<BIG><FONT color=#D0D0D0><A href="IDirectFBFont.html"> <FONT color=#D0D0D0>IDirectFBFont</FONT></A> </FONT></BIG>
</TD><TD nowrap align=left width=50%>
<BIG><FONT color=#E09040> GetStringBreak</FONT></BIG>
</TD></TR>
</TABLE>
</TD></TR>
</TABLE>
<H4>
Get the next explicit or automatic break within a string
along with the logical width of the text, the string length,
and a pointer to the next text line.
</H4>
<TABLE border=0 cellspacing=4 cellpadding=2 bgcolor=#D8E0E8>
<TR><TD colspan=5><I><FONT color=#425469><A href="types.html#DFBResult">DFBResult</A> <b>GetStringBreak (</b></FONT></I></TD></TR>
<TR><TD width=50>
</TD><TD valign=top>
<A href="IDirectFBFont.html">IDirectFBFont</A>
</TD><TD width=20> </TD><TD align=right>
<FONT color=#424242><B>*</B></FONT>
</TD><TD valign=top>
<FONT color=#234269><B>thiz,</B></FONT>
</TD></TR>
<TR><TD width=50>
</TD><TD valign=top>
const char
</TD><TD width=20> </TD><TD align=right>
<FONT color=#424242><B>*</B></FONT>
</TD><TD valign=top>
<FONT color=#234269><B>text,</B></FONT>
</TD></TR>
<TR><TD width=50>
</TD><TD valign=top>
int
</TD><TD width=20> </TD><TD align=right>
<FONT color=#424242><B></B></FONT>
</TD><TD valign=top>
<FONT color=#234269><B>bytes,</B></FONT>
</TD></TR>
<TR><TD width=50>
</TD><TD valign=top>
int
</TD><TD width=20> </TD><TD align=right>
<FONT color=#424242><B></B></FONT>
</TD><TD valign=top>
<FONT color=#234269><B>max_width,</B></FONT>
</TD></TR>
<TR><TD width=50>
</TD><TD valign=top>
int
</TD><TD width=20> </TD><TD align=right>
<FONT color=#424242><B>*</B></FONT>
</TD><TD valign=top>
<FONT color=#234269><B>ret_width,</B></FONT>
</TD></TR>
<TR><TD width=50>
</TD><TD valign=top>
int
</TD><TD width=20> </TD><TD align=right>
<FONT color=#424242><B>*</B></FONT>
</TD><TD valign=top>
<FONT color=#234269><B>ret_str_length,</B></FONT>
</TD></TR>
<TR><TD width=50>
</TD><TD valign=top>
const char
</TD><TD width=20> </TD><TD align=right>
<FONT color=#424242><B>**</B></FONT>
</TD><TD valign=top>
<FONT color=#234269><B>ret_next_line</B></FONT>
</TD></TR>
<TR><TD colspan=5><I><FONT color=#425469><b>);</b></FONT></I></TD></TR>
</TABLE>
</P>
<P>
The bytes specifies the maximum number of bytes to take from the
string or -1 for complete NULL-terminated string.
</P><P>
The max_width specifies logical width of column onto which
the text will be drawn. Then the logical width of fitted
text is returned in ret_width. The returned width may overlap
the max width specified if there's only one character
that fits.
</P><P>
The number of characters that fit into this column is returned
by the ret_str_length. Note that you can not use this value as
the number of bytes to take when using DrawString() as it
represents to the number of characters, not the number of
bytes.
</P><P>
In ret_next_line a pointer to the next line of text is
returned. This will point to NULL or the end of the string if
there's no more break.
</P>
<TABLE width=100% bgcolor=#E0E8F0 border=0 cellspacing=1 cellpadding=3>
<TR><TD width=100>
<a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/"> <img alt="Creative Commons License" style="border-width:0" border="0" src="http://i.creativecommons.org/l/by-sa/3.0/88x31.png" /> </a> </TD><TD>
This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/"> Creative Commons Attribution-Share Alike 3.0 License</a> </TD></TR>
</TABLE>
</BODY>
</HTML>
