include/wx/stattext.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        stattext.h
   3 // Purpose:     wxStaticText base header
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:
   7 // Copyright:   (c) Julian Smart
   8 // RCS-ID:      $Id$
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_STATTEXT_H_BASE_
  13 #define _WX_STATTEXT_H_BASE_
  14
  15 #include "wx/defs.h"
  16
  17 #if wxUSE_STATTEXT
  18
  19 #include "wx/control.h"
  20
  21 /*
  22  * wxStaticText flags
  23  */
  24 #define wxST_NO_AUTORESIZE         0x0001
  25 #define wxST_MARKUP                0x0002
  26 #define wxST_ELLIPSIZE_START       0x0004
  27 #define wxST_ELLIPSIZE_MIDDLE      0x0008
  28 #define wxST_ELLIPSIZE_END         0x0010
  29
  30 extern WXDLLIMPEXP_DATA_CORE(const char) wxStaticTextNameStr[];
  31
  32 class WXDLLIMPEXP_CORE wxStaticTextBase : public wxControl
  33 {
  34 public:
  35     wxStaticTextBase() { }
  36
  37     // wrap the text of the control so that no line is longer than the given
  38     // width (if possible: this function won't break words)
  39     // This function will modify the value returned by GetLabel()!
  40     void Wrap(int width);
  41
  42     // overriden base virtuals
  43     virtual bool AcceptsFocus() const { return false; }
  44     virtual bool HasTransparentBackground() { return true; }
  45
  46     bool IsEllipsized() const
  47     {
  48         return HasFlag(wxST_ELLIPSIZE_START) ||
  49                HasFlag(wxST_ELLIPSIZE_MIDDLE) ||
  50                HasFlag(wxST_ELLIPSIZE_END);
  51     }
  52
  53     // get the string without mnemonic characters ('&') and without markup
  54     // (if the wxST_MARKUP style is set)
  55     virtual wxString GetLabelText() const;
  56
  57     // set label text (mnemonics and markup, if the wxST_MARKUP style is set,
  58     // will be escaped)
  59     virtual void SetLabelText(const wxString& text);
  60
  61
  62     // static utilities for markup handling
  63     // (symmetric to those in wxControl about mnemonics)
  64     // -------------------------------------------------
  65
  66     // get the string without mnemonic characters ('&') and without markup
  67     // (note that markup is always removed; this function is static and cannot
  68     //  check for wxST_MARKUP style presence/absence!)
  69     static wxString GetLabelText(const wxString& label);
  70
  71     // removes the markup recognized by wxStaticText and returns the cleaned string
  72     static wxString RemoveMarkup(const wxString& str);
  73
  74     // escapes all special symbols (<>"'&) present in the given string
  75     // using the corresponding entities (&lt; &gt; &quot; &apos; &amp;)
  76     static wxString EscapeMarkup(const wxString& str);
  77
  78 protected:      // functions required for wxST_ELLIPSIZE_* support
  79
  80     // choose the default border for this window
  81     virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; }
  82
  83     // calls only RemoveMarkup() on the original label
  84     // if the wxST_MARKUP style is set
  85     // (but unlike GetLabelText won't remove mnemonics)
  86     virtual wxString GetLabelWithoutMarkup() const;
  87
  88     // just calls RemoveMarkup() & Ellipsize() on the original label
  89     // if the wxST_MARKUP & wxST_ELLIPSIZE_* styles are set
  90     // (but unlike GetLabelText won't remove mnemonics)
  91     virtual wxString GetEllipsizedLabelWithoutMarkup() const;
  92
  93     // replaces parts of the string with ellipsis if needed
  94     wxString Ellipsize(const wxString& label) const;
  95
  96     // to be called when updating the size of the static text:
  97     // updates the label redoing ellipsization calculations
  98     void UpdateLabel();
  99
 100     // These functions are platform-specific and must be overridden in ports
 101     // which do not natively support ellipsization and they must be implemented
 102     // in a way so that the m_labelOrig member of wxControl is not touched:
 103
 104     // returns the real label currently displayed inside the control.
 105     virtual wxString DoGetLabel() const { return wxEmptyString; }
 106
 107     // sets the real label currently displayed inside the control,
 108     // _without_ invalidating the size. The text passed is always markup-free
 109     // but may contain the mnemonic characters.
 110     virtual void DoSetLabel(const wxString& WXUNUSED(str)) { }
 111
 112 private:
 113     wxDECLARE_NO_COPY_CLASS(wxStaticTextBase);
 114 };
 115
 116 // see wx/generic/stattextg.h for the explanation
 117 #ifndef wxNO_PORT_STATTEXT_INCLUDE
 118
 119 #if defined(__WXUNIVERSAL__)
 120     #include "wx/univ/stattext.h"
 121 #elif defined(__WXMSW__)
 122     #include "wx/msw/stattext.h"
 123 #elif defined(__WXMOTIF__)
 124     #include "wx/motif/stattext.h"
 125 #elif defined(__WXGTK20__)
 126     #include "wx/gtk/stattext.h"
 127 #elif defined(__WXGTK__)
 128     #include "wx/gtk1/stattext.h"
 129 #elif defined(__WXMAC__)
 130     #include "wx/osx/stattext.h"
 131 #elif defined(__WXCOCOA__)
 132     #include "wx/cocoa/stattext.h"
 133 #elif defined(__WXPM__)
 134     #include "wx/os2/stattext.h"
 135 #elif defined(__WXPALMOS__)
 136     #include "wx/palmos/stattext.h"
 137 #endif
 138
 139 #endif // !wxNO_PORT_STATTEXT_INCLUDE
 140
 141 #endif // wxUSE_STATTEXT
 142
 143 #endif // _WX_STATTEXT_H_BASE_