pango-Layout-Objects          package:RGtk2          R Documentation

_L_a_y_o_u_t _O_b_j_e_c_t_s

_D_e_s_c_r_i_p_t_i_o_n:

     High-level layout driver objects

_M_e_t_h_o_d_s _a_n_d _F_u_n_c_t_i_o_n_s:

     'pangoLayoutNew(context)'
      'pangoLayoutCopy(object)'
      'pangoLayoutGetContext(object)'
      'pangoLayoutContextChanged(object)'
      'pangoLayoutSetText(object, text, length = -1)'
      'pangoLayoutGetText(object)'
      'pangoLayoutSetMarkup(object, markup, length = -1)'
      'pangoLayoutSetMarkupWithAccel(object, markup, accel.marker)'
      'pangoLayoutSetAttributes(object, attrs)'
      'pangoLayoutGetAttributes(object)'
      'pangoLayoutSetFontDescription(object, desc = NULL)'
      'pangoLayoutGetFontDescription(object)'
      'pangoLayoutSetWidth(object, width)'
      'pangoLayoutGetWidth(object)'
      'pangoLayoutSetHeight(object, height)'
      'pangoLayoutGetHeight(object)'
      'pangoLayoutSetWrap(object, wrap)'
      'pangoLayoutGetWrap(object)'
      'pangoLayoutIsWrapped(object)'
      'pangoLayoutSetEllipsize(object, ellipsize)'
      'pangoLayoutGetEllipsize(object)'
      'pangoLayoutIsEllipsized(object)'
      'pangoLayoutSetIndent(object, indent)'
      'pangoLayoutGetIndent(object)'
      'pangoLayoutGetSpacing(object)'
      'pangoLayoutSetSpacing(object, spacing)'
      'pangoLayoutSetJustify(object, justify)'
      'pangoLayoutGetJustify(object)'
      'pangoLayoutSetAutoDir(object, auto.dir)'
      'pangoLayoutGetAutoDir(object)'
      'pangoLayoutSetAlignment(object, alignment)'
      'pangoLayoutGetAlignment(object)'
      'pangoLayoutSetTabs(object, tabs = NULL)'
      'pangoLayoutGetTabs(object)'
      'pangoLayoutSetSingleParagraphMode(object, setting)'
      'pangoLayoutGetSingleParagraphMode(object)'
      'pangoLayoutGetUnknownGlyphsCount(object)'
      'pangoLayoutGetLogAttrs(object)'
      'pangoLayoutIndexToPos(object, index, pos)'
      'pangoLayoutIndexToLineX(object, index., trailing)'
      'pangoLayoutXyToIndex(object, x, y)'
      'pangoLayoutGetCursorPos(object, index)'
      'pangoLayoutMoveCursorVisually(object, strong, old.index,
     old.trailing, direction)'
      'pangoLayoutGetExtents(object)'
      'pangoLayoutGetPixelExtents(object)'
      'pangoLayoutGetSize(object)'
      'pangoLayoutGetPixelSize(object)'
      'pangoLayoutGetLineCount(object)'
      'pangoLayoutGetLine(object, line)'
      'pangoLayoutGetLineReadonly(object, line)'
      'pangoLayoutGetLines(object)'
      'pangoLayoutGetLinesReadonly(object)'
      'pangoLayoutGetIter(object)'
      'pangoLayoutIterNextRun(object)'
      'pangoLayoutIterNextChar(object)'
      'pangoLayoutIterNextCluster(object)'
      'pangoLayoutIterNextLine(object)'
      'pangoLayoutIterAtLastLine(object)'
      'pangoLayoutIterGetIndex(object)'
      'pangoLayoutIterGetBaseline(object)'
      'pangoLayoutIterGetRun(object)'
      'pangoLayoutIterGetRunReadonly(object)'
      'pangoLayoutIterGetLine(object)'
      'pangoLayoutIterGetLineReadonly(object)'
      'pangoLayoutIterGetLayout(iter)'
      'pangoLayoutIterGetCharExtents(object)'
      'pangoLayoutIterGetClusterExtents(object)'
      'pangoLayoutIterGetRunExtents(object)'
      'pangoLayoutIterGetLineYrange(object)'
      'pangoLayoutIterGetLineExtents(object)'
      'pangoLayoutIterGetLayoutExtents(object)'
      'pangoLayoutLineGetExtents(object)'
      'pangoLayoutLineGetPixelExtents(object)'
      'pangoLayoutLineIndexToX(object, index, trailing)'
      'pangoLayoutLineXToIndex(object, x.pos)'
      'pangoLayoutLineGetXRanges(object, start.index, end.index)'
      'pangoLayout(context)'

_H_i_e_r_a_r_c_h_y:

     GObject
        +----PangoLayout 

_D_e_t_a_i_l_e_d _D_e_s_c_r_i_p_t_i_o_n:

     While complete access to the layout capabilities of Pango is
     provided using the detailed interfaces for itemization and
     shaping, using that functionality directly involves writing a
     fairly large amount of code. The objects and functions in this
     section provide a high-level driver for formatting entire
     paragraphs of text at once.

_S_t_r_u_c_t_u_r_e_s:


     '_P_a_n_g_o_L_a_y_o_u_t' The 'PangoLayout' structure represents an entire
          paragraph of text. It is initialized with a 'PangoContext',
          UTF-8 string and set of attributes for that string. Once that
          is done, the set of formatted lines can be extracted from the
          object, the layout can be rendered, and conversion between
          logical character positions within the layout's text, and the
          physical position of the resulting glyphs can be made.

          There are also a number of parameters to adjust the
          formatting of a 'PangoLayout', which are illustrated in . It
          is possible, as well, to ignore the 2-D setup, and simply
          treat the results of a 'PangoLayout' as a list of lines.

          The 'PangoLayout' structure is opaque, and has no
          user-visible fields.


     '_P_a_n_g_o_L_a_y_o_u_t_I_t_e_r' A 'PangoLayoutIter' structure can be used to
          iterate over the visual extents of a 'PangoLayout'. 

          The 'PangoLayoutIter' structure is opaque, and  has no
          user-visible fields.


     '_P_a_n_g_o_L_a_y_o_u_t_L_i_n_e' The 'PangoLayoutLine' structure represents one
          of the lines resulting from laying out a paragraph via
          'PangoLayout'. 'PangoLayoutLine' structures are obtained by
          calling 'pangoLayoutGetLine' and are only valid until the
          text, attributes, or settings of the parent 'PangoLayout' are
          modified.

          Routines for rendering PangoLayout objects are provided in
          code specific to each rendering system.

          '_l_a_y_o_u_t' ['PangoLayout'] the parent layout for this line

          '_s_t_a_r_t_I_n_d_e_x' [integer] the start of the line as byte index
               into 'layout->text'

          '_l_e_n_g_t_h' [integer] the length of the line in bytes

          '_r_u_n_s' [list] a list containing the runs of the line in
               visual order

          '_i_s_P_a_r_a_g_r_a_p_h_S_t_a_r_t' [numeric] 'TRUE' if this is the first line
               of the paragraph

          '_r_e_s_o_l_v_e_d_D_i_r' [numeric] the resolved 'PangoDirection' of the
               line


_C_o_n_v_e_n_i_e_n_t _C_o_n_s_t_r_u_c_t_i_o_n:

     'pangoLayout' is the equivalent of 'pangoLayoutNew'.

_E_n_u_m_s _a_n_d _F_l_a_g_s:


     '_P_a_n_g_o_W_r_a_p_M_o_d_e' A 'PangoWrapMode' describes how to wrap the lines
          of a 'PangoLayout' to the desired width.

          '_w_o_r_d' wrap lines at word boundaries.

          '_c_h_a_r' wrap lines at character boundaries.


     '_P_a_n_g_o_E_l_l_i_p_s_i_z_e_M_o_d_e' The 'PangoEllipsizeMode' type describes what
          sort of (if any) ellipsization should be applied to a line of
          text. In the ellipsization process characters are removed
          from the text in order to make it fit to a given width and
          replaced with an ellipsis.  

          '_n_o_n_e' No ellipsization

          '_s_t_a_r_t' Omit characters at the start of the text

          '_m_i_d_d_l_e' Omit characters in the middle of the text

          '_e_n_d' Omit characters at the end of the text


     '_P_a_n_g_o_A_l_i_g_n_m_e_n_t' A 'PangoAlignment' describes how to align the
          lines of a 'PangoLayout' within the available space. If the
          'PangoLayout' is set to justify using
          'pangoLayoutSetJustify', this only has effect for partial
          lines.

          '_l_e_f_t' Put all available space on the right

          '_c_e_n_t_e_r' Center the line within the available space

          '_r_i_g_h_t' Put all available space on the left


_A_u_t_h_o_r(_s):

     Derived by RGtkGen from GTK+ documentation

_R_e_f_e_r_e_n_c_e_s:

     <URL:
     http://developer.gnome.org/doc/API/2.0/pango/pango-Layout-Objects.html>

