include/wx/textwrapper.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/textwrapper.h
   3 // Purpose:     declaration of wxTextWrapper class
   4 // Author:      Vadim Zeitlin
   5 // Created:     2009-05-31 (extracted from dlgcmn.cpp via wx/private/stattext.h)
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) 1999, 2009 Vadim Zeitlin <vadim@wxwidgets.org>
   8 // Licence:     wxWindows licence
   9 ///////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_TEXTWRAPPER_H_
  12 #define _WX_TEXTWRAPPER_H_
  13
  14 #include "wx/window.h"
  15
  16 // ----------------------------------------------------------------------------
  17 // wxTextWrapper
  18 // ----------------------------------------------------------------------------
  19
  20 // this class is used to wrap the text on word boundary: wrapping is done by
  21 // calling OnStartLine() and OnOutputLine() functions
  22 class wxTextWrapper
  23 {
  24 public:
  25     wxTextWrapper() { m_eol = false; }
  26
  27     // win is used for getting the font, text is the text to wrap, width is the
  28     // max line width or -1 to disable wrapping
  29     void Wrap(wxWindow *win, const wxString& text, int widthMax);
  30
  31     // we don't need it, but just to avoid compiler warnings
  32     virtual ~wxTextWrapper() { }
  33
  34 protected:
  35     // line may be empty
  36     virtual void OnOutputLine(const wxString& line) = 0;
  37
  38     // called at the start of every new line (except the very first one)
  39     virtual void OnNewLine() { }
  40
  41 private:
  42     // call OnOutputLine() and set m_eol to true
  43     void DoOutputLine(const wxString& line)
  44     {
  45         OnOutputLine(line);
  46
  47         m_eol = true;
  48     }
  49
  50     // this function is a destructive inspector: when it returns true it also
  51     // resets the flag to false so calling it again wouldn't return true any
  52     // more
  53     bool IsStartOfNewLine()
  54     {
  55         if ( !m_eol )
  56             return false;
  57
  58         m_eol = false;
  59
  60         return true;
  61     }
  62
  63
  64     bool m_eol;
  65
  66     wxDECLARE_NO_COPY_CLASS(wxTextWrapper);
  67 };
  68
  69 #endif // _WX_TEXTWRAPPER_H_
  70