kc3-lang/ftgl/src/FTGL/FTSimpleLayout.h

• Show log

  Commit

• Hash : 9fa3bb52
  Author :
  Date : 2008-05-01T10:04:14
  

  * Moved C constructor bindings to FTFont.h and FTLayout.h so that they appear in the same file in the generated documentation. * Various minor documentation updates.

Download

• src/FTGL/FTSimpleLayout.h

• /*
   * FTGL - OpenGL font library
   *
   * Copyright (c) 2001-2004 Henry Maddocks <ftgl@opengl.geek.nz>
   *
   * Permission is hereby granted, free of charge, to any person obtaining
   * a copy of this software and associated documentation files (the
   * "Software"), to deal in the Software without restriction, including
   * without limitation the rights to use, copy, modify, merge, publish,
   * distribute, sublicense, and/or sell copies of the Software, and to
   * permit persons to whom the Software is furnished to do so, subject to
   * the following conditions:
   *
   * The above copyright notice and this permission notice shall be
   * included in all copies or substantial portions of the Software.
   *
   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
   * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
   * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
   * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
   * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
   * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
   */
  
  #ifndef __ftgl__
  #   warning This header is deprecated. Please use <FTGL/ftgl.h> from now.
  #   include <FTGL/ftgl.h>
  #endif
  
  #ifndef __FTSimpleLayout__
  #define __FTSimpleLayout__
  
  #ifdef __cplusplus
  
  
  class FTFont;
  
  /**
   * FTSimpleLayout is a specialisation of FTLayout for simple text boxes.
   *
   * This class has basic support for text wrapping, left, right and centered
   * alignment, and text justification.
   *
   * @see     FTLayout
   */
  class FTGL_EXPORT FTSimpleLayout : public FTLayout
  {
      public:
          /**
           * Initializes line spacing to 1.0, alignment to
           * ALIGN_LEFT and wrap to 100.0
           */
          FTSimpleLayout();
  
          /**
           * Destructor
           */
          ~FTSimpleLayout() {}
  
          /**
           * Set the font to use for rendering the text.
           *
           * @param fontInit A pointer to the new font.  The font is
           *                 referenced by this but will not be
           *                 disposed of when this is deleted.
           */
          void SetFont(FTFont *fontInit);
  
          /**
           * @return The current font.
           */
          FTFont *GetFont();
  
          /**
           * The maximum line length for formatting text.
           *
           * @param LineLength The new line length.
           */
          void SetLineLength(const float LineLength);
  
          /**
           * @return The current line length.
           */
          float GetLineLength() const;
  
          /**
           * The text alignment mode used to distribute
           * space within a line or rendered text.
           *
           * @param Alignment The new alignment mode.
           */
          void SetAlignment(const FTGL::TextAlignment Alignment);
  
          /**
           * @return The text alignment mode.
           */
          FTGL::TextAlignment GetAlignment() const;
  
          /**
           * Sets the line height.
           *
           * @param LineSpacing The height of each line of text expressed as
           *                    a percentage of the current fonts line height.
           */
          void SetLineSpacing(const float LineSpacing);
  
          /**
           * @return The line spacing.
           */
          float GetLineSpacing() const;
  
          /**
           * Render a string of characters and distribute extra space amongst
           * the whitespace regions of the string.
           *
           * @param string      'C' style string to output.
           * @param ExtraSpace  The amount of extra space to add to each run of
           *                    whitespace.
           */
          void RenderSpace(const char *string, const float ExtraSpace = 0.0);
  
          /**
           * Render a string of characters and distribute extra space amongst
           * the whitespace regions of the string.
           *
           * @param string      wchar_t string to output.
           * @param ExtraSpace  The amount of extra space to add to each run of
           *                    whitespace.
           */
          void RenderSpace(const wchar_t *string, const float ExtraSpace = 0.0);
  };
  
  #endif //__cplusplus
  
  #endif  /* __FTSimpleLayout__ */
  
  

Download