]> git.saurik.com Git - wxWidgets.git/blame - include/wx/stattext.h
Avoid including pipe stream headers when streams are disabled.
[wxWidgets.git] / include / wx / stattext.h
CommitLineData
2ecf902b 1/////////////////////////////////////////////////////////////////////////////
80fdcdb9 2// Name: wx/stattext.h
2ecf902b 3// Purpose: wxStaticText base header
99d80019 4// Author: Julian Smart
2ecf902b
WS
5// Modified by:
6// Created:
99d80019 7// Copyright: (c) Julian Smart
2ecf902b
WS
8// RCS-ID: $Id$
9// Licence: wxWindows licence
10/////////////////////////////////////////////////////////////////////////////
11
34138703
JS
12#ifndef _WX_STATTEXT_H_BASE_
13#define _WX_STATTEXT_H_BASE_
c801d85f 14
2ecf902b
WS
15#include "wx/defs.h"
16
1e6feb95
VZ
17#if wxUSE_STATTEXT
18
19#include "wx/control.h"
20
39bc0347
VZ
21/*
22 * wxStaticText flags
23 */
24#define wxST_NO_AUTORESIZE 0x0001
3da9cffc 25// free 0x0002 bit
5c87527c
FM
26#define wxST_ELLIPSIZE_START 0x0004
27#define wxST_ELLIPSIZE_MIDDLE 0x0008
28#define wxST_ELLIPSIZE_END 0x0010
39bc0347 29
53a2db12 30extern WXDLLIMPEXP_DATA_CORE(const char) wxStaticTextNameStr[];
1e6feb95 31
53a2db12 32class WXDLLIMPEXP_CORE wxStaticTextBase : public wxControl
1e6feb95
VZ
33{
34public:
fc7a2a60
VZ
35 wxStaticTextBase() { }
36
5d1b4919
VZ
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)
39bc0347 39 // This function will modify the value returned by GetLabel()!
5d1b4919
VZ
40 void Wrap(int width);
41
4c51a665 42 // overridden base virtuals
bd507486 43 virtual bool AcceptsFocus() const { return false; }
7c7a653b 44 virtual bool HasTransparentBackground() { return true; }
fc7a2a60 45
39bc0347
VZ
46 bool IsEllipsized() const
47 {
48 return HasFlag(wxST_ELLIPSIZE_START) ||
49 HasFlag(wxST_ELLIPSIZE_MIDDLE) ||
50 HasFlag(wxST_ELLIPSIZE_END);
51 }
52
39bc0347
VZ
53protected: // functions required for wxST_ELLIPSIZE_* support
54
dc797d8e
JS
55 // choose the default border for this window
56 virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; }
57
3da9cffc
VZ
58 // Calls Ellipsize() on the real label if necessary. Unlike GetLabelText(),
59 // keeps the mnemonics instead of removing them.
60 virtual wxString GetEllipsizedLabel() const;
39bc0347 61
3da9cffc
VZ
62 // Replaces parts of the string with ellipsis according to the ellipsize
63 // style. Shouldn't be called if we don't have any.
39bc0347
VZ
64 wxString Ellipsize(const wxString& label) const;
65
66 // to be called when updating the size of the static text:
67 // updates the label redoing ellipsization calculations
68 void UpdateLabel();
69
70 // These functions are platform-specific and must be overridden in ports
71 // which do not natively support ellipsization and they must be implemented
7517dcb5 72 // in a way so that the m_labelOrig member of wxControl is not touched:
39bc0347
VZ
73
74 // returns the real label currently displayed inside the control.
75 virtual wxString DoGetLabel() const { return wxEmptyString; }
76
77 // sets the real label currently displayed inside the control,
7517dcb5
FM
78 // _without_ invalidating the size. The text passed is always markup-free
79 // but may contain the mnemonic characters.
39bc0347
VZ
80 virtual void DoSetLabel(const wxString& WXUNUSED(str)) { }
81
fc7a2a60 82private:
c0c133e1 83 wxDECLARE_NO_COPY_CLASS(wxStaticTextBase);
1e6feb95
VZ
84};
85
bce49490
VZ
86// see wx/generic/stattextg.h for the explanation
87#ifndef wxNO_PORT_STATTEXT_INCLUDE
88
1e6feb95
VZ
89#if defined(__WXUNIVERSAL__)
90 #include "wx/univ/stattext.h"
91#elif defined(__WXMSW__)
92 #include "wx/msw/stattext.h"
2049ba38 93#elif defined(__WXMOTIF__)
1e6feb95 94 #include "wx/motif/stattext.h"
1be7a35c 95#elif defined(__WXGTK20__)
1e6feb95 96 #include "wx/gtk/stattext.h"
1be7a35c
MR
97#elif defined(__WXGTK__)
98 #include "wx/gtk1/stattext.h"
34138703 99#elif defined(__WXMAC__)
ef0e9220 100 #include "wx/osx/stattext.h"
e64df9bc
DE
101#elif defined(__WXCOCOA__)
102 #include "wx/cocoa/stattext.h"
1777b9bb 103#elif defined(__WXPM__)
1e6feb95 104 #include "wx/os2/stattext.h"
c801d85f
KB
105#endif
106
bce49490
VZ
107#endif // !wxNO_PORT_STATTEXT_INCLUDE
108
1e6feb95
VZ
109#endif // wxUSE_STATTEXT
110
bce49490 111#endif // _WX_STATTEXT_H_BASE_