1999-07-14 18:55:57 -04:00
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
2006-04-14 13:01:16 -04:00
|
|
|
// Name: wx/textctrl.h
|
1999-07-14 18:55:57 -04:00
|
|
|
// Purpose: wxTextCtrlBase class - the interface of wxTextCtrl
|
|
|
|
// Author: Vadim Zeitlin
|
|
|
|
// Modified by:
|
|
|
|
// Created: 13.07.99
|
|
|
|
// RCS-ID: $Id$
|
2005-05-04 14:57:50 -04:00
|
|
|
// Copyright: (c) Vadim Zeitlin
|
2004-05-23 16:53:33 -04:00
|
|
|
// Licence: wxWindows licence
|
1999-07-14 18:55:57 -04:00
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
1998-08-14 20:23:28 -04:00
|
|
|
#ifndef _WX_TEXTCTRL_H_BASE_
|
|
|
|
#define _WX_TEXTCTRL_H_BASE_
|
1998-05-20 10:01:55 -04:00
|
|
|
|
1999-07-14 18:55:57 -04:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// headers
|
|
|
|
// ----------------------------------------------------------------------------
|
2001-05-26 23:28:28 -04:00
|
|
|
|
1999-07-14 18:55:57 -04:00
|
|
|
#include "wx/defs.h"
|
2001-06-26 16:59:19 -04:00
|
|
|
|
|
|
|
#if wxUSE_TEXTCTRL
|
|
|
|
|
1999-07-14 18:55:57 -04:00
|
|
|
#include "wx/control.h" // the base class
|
2004-02-04 09:56:14 -05:00
|
|
|
#include "wx/dynarray.h" // wxArrayInt
|
|
|
|
#include "wx/gdicmn.h" // wxPoint
|
1999-07-14 18:55:57 -04:00
|
|
|
|
2005-04-13 13:51:16 -04:00
|
|
|
// Open Watcom 1.3 does allow only ios::rdbuf() while
|
|
|
|
// we want something with streambuf parameter
|
|
|
|
// Also, can't use streambuf if making or using a DLL :-(
|
1999-07-14 18:55:57 -04:00
|
|
|
|
2005-04-13 13:51:16 -04:00
|
|
|
#if defined(__WATCOMC__) || \
|
|
|
|
defined(__MWERKS__) || \
|
2004-03-18 18:12:58 -05:00
|
|
|
(defined(__WINDOWS__) && (defined(WXUSINGDLL) || defined(WXMAKINGDLL)))
|
2005-04-13 13:51:16 -04:00
|
|
|
#define wxHAS_TEXT_WINDOW_STREAM 0
|
|
|
|
#elif wxUSE_STD_IOSTREAM
|
|
|
|
#include "wx/ioswrap.h"
|
|
|
|
#define wxHAS_TEXT_WINDOW_STREAM 1
|
|
|
|
#else
|
|
|
|
#define wxHAS_TEXT_WINDOW_STREAM 0
|
1999-07-14 18:55:57 -04:00
|
|
|
#endif
|
|
|
|
|
2005-04-13 13:51:16 -04:00
|
|
|
#if WXWIN_COMPATIBILITY_2_4 && !wxHAS_TEXT_WINDOW_STREAM
|
|
|
|
// define old flag if one could use it somewhere
|
|
|
|
#define NO_TEXT_WINDOW_STREAM
|
2004-11-08 14:20:28 -05:00
|
|
|
#endif
|
|
|
|
|
1999-07-15 09:42:27 -04:00
|
|
|
class WXDLLEXPORT wxTextCtrl;
|
2001-11-26 09:50:50 -05:00
|
|
|
class WXDLLEXPORT wxTextCtrlBase;
|
1999-07-15 09:42:27 -04:00
|
|
|
|
2004-02-04 09:56:14 -05:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// wxTextCtrl types
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
// wxTextPos is the position in the text
|
|
|
|
typedef long wxTextPos;
|
|
|
|
|
|
|
|
// wxTextCoord is the line or row number (which should have been unsigned but
|
|
|
|
// is long for backwards compatibility)
|
|
|
|
typedef long wxTextCoord;
|
|
|
|
|
1999-07-14 18:55:57 -04:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// constants
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
2006-01-16 09:59:55 -05:00
|
|
|
extern WXDLLEXPORT_DATA(const wxChar) wxTextCtrlNameStr[];
|
1999-07-14 18:55:57 -04:00
|
|
|
|
2005-01-19 11:25:34 -05:00
|
|
|
// this is intentionally not enum to avoid warning fixes with
|
|
|
|
// typecasting from enum type to wxTextCoord
|
|
|
|
const wxTextCoord wxOutOfRangeTextCoord = -1;
|
|
|
|
const wxTextCoord wxInvalidTextCoord = -2;
|
|
|
|
|
2001-07-29 18:40:21 -04:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// wxTextCtrl style flags
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
Applied patch [ 603858 ] wxTextCtrl text alignment patch
Benjamin I. Williams
This patch implements three new flags for the
wxTextCtrl control. The flags are wxTE_LEFT,
wxTE_CENTRE, and wxTE_RIGHT. These flags can change
the way text is aligned inside an edit control, which
is useful when the user is editing numbers or dates.
At Vadim's recommendation, the patch implements the
alignment flags so they are equal to the corresponding
wxALIGN_* value. wxTE_LEFT is actually 0x0000, and is
just a place holder. wxTE_CENTRE is equal to
wx_ALIGN_CENTER_HORIZONTAL (0x0100), and wxTE_RIGHT is
equal to wxALIGN_RIGHT (0x0100). I couldn't agree more
with this idea.
As Vadim pointed out, choosing to set the text
alignment flags to the corresponding wxALIGN_* flags
has a slight negative side effect: the values 0x0100
and 0x0200 collide with the existing flags
wxTE_NO_VSCROLL and wxTE_AUTO_SCROLL. A valid point
was raised, however, which stated that the flags would
never really be used at the same time, and also that
wxTE_AUTO_SCROLL is (possibly) going to be deprecated
anyway.
While this collision is not really a problem, I didn't
like the idea of someone specifying wxTE_NO_VSCROLL and
ending up with with a centered text control ! Thus, I
chose to move both wxTE_NO_VSCROLL and wxTE_AUTO_SCROLL
down to the free bits 0x0002 and 0x0008, respectively.
I'll leave the final say up to Vadim and the rest of
you whether you want to move these flags down or keep
them where they are (with collisions). What truly
matters to me is that I can now create text controls
with the proper alignment!
This patch also updates the documentation.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@16989 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2002-09-05 12:15:30 -04:00
|
|
|
#define wxTE_NO_VSCROLL 0x0002
|
|
|
|
#define wxTE_AUTO_SCROLL 0x0008
|
|
|
|
|
2001-07-29 18:40:21 -04:00
|
|
|
#define wxTE_READONLY 0x0010
|
|
|
|
#define wxTE_MULTILINE 0x0020
|
|
|
|
#define wxTE_PROCESS_TAB 0x0040
|
|
|
|
|
Applied patch [ 603858 ] wxTextCtrl text alignment patch
Benjamin I. Williams
This patch implements three new flags for the
wxTextCtrl control. The flags are wxTE_LEFT,
wxTE_CENTRE, and wxTE_RIGHT. These flags can change
the way text is aligned inside an edit control, which
is useful when the user is editing numbers or dates.
At Vadim's recommendation, the patch implements the
alignment flags so they are equal to the corresponding
wxALIGN_* value. wxTE_LEFT is actually 0x0000, and is
just a place holder. wxTE_CENTRE is equal to
wx_ALIGN_CENTER_HORIZONTAL (0x0100), and wxTE_RIGHT is
equal to wxALIGN_RIGHT (0x0100). I couldn't agree more
with this idea.
As Vadim pointed out, choosing to set the text
alignment flags to the corresponding wxALIGN_* flags
has a slight negative side effect: the values 0x0100
and 0x0200 collide with the existing flags
wxTE_NO_VSCROLL and wxTE_AUTO_SCROLL. A valid point
was raised, however, which stated that the flags would
never really be used at the same time, and also that
wxTE_AUTO_SCROLL is (possibly) going to be deprecated
anyway.
While this collision is not really a problem, I didn't
like the idea of someone specifying wxTE_NO_VSCROLL and
ending up with with a centered text control ! Thus, I
chose to move both wxTE_NO_VSCROLL and wxTE_AUTO_SCROLL
down to the free bits 0x0002 and 0x0008, respectively.
I'll leave the final say up to Vadim and the rest of
you whether you want to move these flags down or keep
them where they are (with collisions). What truly
matters to me is that I can now create text controls
with the proper alignment!
This patch also updates the documentation.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@16989 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2002-09-05 12:15:30 -04:00
|
|
|
// alignment flags
|
|
|
|
#define wxTE_LEFT 0x0000 // 0x0000
|
|
|
|
#define wxTE_CENTER wxALIGN_CENTER_HORIZONTAL // 0x0100
|
|
|
|
#define wxTE_RIGHT wxALIGN_RIGHT // 0x0200
|
|
|
|
#define wxTE_CENTRE wxTE_CENTER
|
|
|
|
|
2001-07-29 18:40:21 -04:00
|
|
|
// this style means to use RICHEDIT control and does something only under wxMSW
|
|
|
|
// and Win32 and is silently ignored under all other platforms
|
|
|
|
#define wxTE_RICH 0x0080
|
Applied patch [ 603858 ] wxTextCtrl text alignment patch
Benjamin I. Williams
This patch implements three new flags for the
wxTextCtrl control. The flags are wxTE_LEFT,
wxTE_CENTRE, and wxTE_RIGHT. These flags can change
the way text is aligned inside an edit control, which
is useful when the user is editing numbers or dates.
At Vadim's recommendation, the patch implements the
alignment flags so they are equal to the corresponding
wxALIGN_* value. wxTE_LEFT is actually 0x0000, and is
just a place holder. wxTE_CENTRE is equal to
wx_ALIGN_CENTER_HORIZONTAL (0x0100), and wxTE_RIGHT is
equal to wxALIGN_RIGHT (0x0100). I couldn't agree more
with this idea.
As Vadim pointed out, choosing to set the text
alignment flags to the corresponding wxALIGN_* flags
has a slight negative side effect: the values 0x0100
and 0x0200 collide with the existing flags
wxTE_NO_VSCROLL and wxTE_AUTO_SCROLL. A valid point
was raised, however, which stated that the flags would
never really be used at the same time, and also that
wxTE_AUTO_SCROLL is (possibly) going to be deprecated
anyway.
While this collision is not really a problem, I didn't
like the idea of someone specifying wxTE_NO_VSCROLL and
ending up with with a centered text control ! Thus, I
chose to move both wxTE_NO_VSCROLL and wxTE_AUTO_SCROLL
down to the free bits 0x0002 and 0x0008, respectively.
I'll leave the final say up to Vadim and the rest of
you whether you want to move these flags down or keep
them where they are (with collisions). What truly
matters to me is that I can now create text controls
with the proper alignment!
This patch also updates the documentation.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@16989 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2002-09-05 12:15:30 -04:00
|
|
|
|
2001-07-29 18:40:21 -04:00
|
|
|
#define wxTE_PROCESS_ENTER 0x0400
|
|
|
|
#define wxTE_PASSWORD 0x0800
|
|
|
|
|
|
|
|
// automatically detect the URLs and generate the events when mouse is
|
|
|
|
// moved/clicked over an URL
|
|
|
|
//
|
2005-02-18 21:55:32 -05:00
|
|
|
// this is for Win32 richedit and wxGTK2 multiline controls only so far
|
2001-07-29 18:40:21 -04:00
|
|
|
#define wxTE_AUTO_URL 0x1000
|
|
|
|
|
2001-10-17 20:53:35 -04:00
|
|
|
// by default, the Windows text control doesn't show the selection when it
|
|
|
|
// doesn't have focus - use this style to force it to always show it
|
|
|
|
#define wxTE_NOHIDESEL 0x2000
|
|
|
|
|
2005-03-27 10:25:21 -05:00
|
|
|
// use wxHSCROLL to not wrap text at all, wxTE_CHARWRAP to wrap it at any
|
2001-11-25 13:11:47 -05:00
|
|
|
// position and wxTE_WORDWRAP to wrap at words boundary
|
2005-03-27 10:25:21 -05:00
|
|
|
//
|
|
|
|
// if no wrapping style is given at all, the control wraps at word boundary
|
2001-11-25 13:11:47 -05:00
|
|
|
#define wxTE_DONTWRAP wxHSCROLL
|
2005-03-27 10:25:21 -05:00
|
|
|
#define wxTE_CHARWRAP 0x4000 // wrap at any position
|
|
|
|
#define wxTE_WORDWRAP 0x0001 // wrap only at words boundaries
|
|
|
|
#define wxTE_BESTWRAP 0x0000 // this is the default
|
|
|
|
|
2006-04-14 13:01:16 -04:00
|
|
|
#if WXWIN_COMPATIBILITY_2_6
|
|
|
|
// obsolete synonym
|
|
|
|
#define wxTE_LINEWRAP wxTE_CHARWRAP
|
|
|
|
#endif // WXWIN_COMPATIBILITY_2_6
|
2001-11-25 13:11:47 -05:00
|
|
|
|
2002-01-08 20:32:02 -05:00
|
|
|
// force using RichEdit version 2.0 or 3.0 instead of 1.0 (default) for
|
|
|
|
// wxTE_RICH controls - can be used together with or instead of wxTE_RICH
|
|
|
|
#define wxTE_RICH2 0x8000
|
|
|
|
|
2005-03-18 09:26:57 -05:00
|
|
|
// reuse wxTE_RICH2's value for CAPEDIT control on Windows CE
|
|
|
|
#if defined(__SMARTPHONE__) || defined(__POCKETPC__)
|
|
|
|
#define wxTE_CAPITALIZE wxTE_RICH2
|
|
|
|
#else
|
|
|
|
#define wxTE_CAPITALIZE 0
|
|
|
|
#endif
|
|
|
|
|
2006-09-24 07:40:33 -04:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// wxTextCtrl file types
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
#define wxTEXT_TYPE_ANY 0
|
|
|
|
|
2004-02-04 09:56:14 -05:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// wxTextCtrl::HitTest return values
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
// the point asked is ...
|
|
|
|
enum wxTextCtrlHitTestResult
|
|
|
|
{
|
|
|
|
wxTE_HT_UNKNOWN = -2, // this means HitTest() is simply not implemented
|
|
|
|
wxTE_HT_BEFORE, // either to the left or upper
|
|
|
|
wxTE_HT_ON_TEXT, // directly on
|
|
|
|
wxTE_HT_BELOW, // below [the last line]
|
|
|
|
wxTE_HT_BEYOND // after [the end of line]
|
|
|
|
};
|
|
|
|
// ... the character returned
|
|
|
|
|
2003-06-20 12:25:31 -04:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// Types for wxTextAttr
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
// Alignment
|
|
|
|
|
|
|
|
enum wxTextAttrAlignment
|
|
|
|
{
|
|
|
|
wxTEXT_ALIGNMENT_DEFAULT,
|
|
|
|
wxTEXT_ALIGNMENT_LEFT,
|
|
|
|
wxTEXT_ALIGNMENT_CENTRE,
|
|
|
|
wxTEXT_ALIGNMENT_CENTER = wxTEXT_ALIGNMENT_CENTRE,
|
|
|
|
wxTEXT_ALIGNMENT_RIGHT,
|
|
|
|
wxTEXT_ALIGNMENT_JUSTIFIED
|
|
|
|
};
|
|
|
|
|
|
|
|
// Flags to indicate which attributes are being applied
|
|
|
|
|
|
|
|
#define wxTEXT_ATTR_TEXT_COLOUR 0x0001
|
|
|
|
#define wxTEXT_ATTR_BACKGROUND_COLOUR 0x0002
|
|
|
|
#define wxTEXT_ATTR_FONT_FACE 0x0004
|
|
|
|
#define wxTEXT_ATTR_FONT_SIZE 0x0008
|
|
|
|
#define wxTEXT_ATTR_FONT_WEIGHT 0x0010
|
|
|
|
#define wxTEXT_ATTR_FONT_ITALIC 0x0020
|
|
|
|
#define wxTEXT_ATTR_FONT_UNDERLINE 0x0040
|
|
|
|
#define wxTEXT_ATTR_FONT \
|
2005-06-13 08:19:33 -04:00
|
|
|
( wxTEXT_ATTR_FONT_FACE | wxTEXT_ATTR_FONT_SIZE | wxTEXT_ATTR_FONT_WEIGHT | \
|
|
|
|
wxTEXT_ATTR_FONT_ITALIC | wxTEXT_ATTR_FONT_UNDERLINE )
|
2003-06-20 12:25:31 -04:00
|
|
|
#define wxTEXT_ATTR_ALIGNMENT 0x0080
|
|
|
|
#define wxTEXT_ATTR_LEFT_INDENT 0x0100
|
|
|
|
#define wxTEXT_ATTR_RIGHT_INDENT 0x0200
|
|
|
|
#define wxTEXT_ATTR_TABS 0x0400
|
|
|
|
|
2001-05-26 23:28:28 -04:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// wxTextAttr: a structure containing the visual attributes of a text
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
class WXDLLEXPORT wxTextAttr
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
// ctors
|
2003-06-20 12:25:31 -04:00
|
|
|
wxTextAttr() { Init(); }
|
2001-05-26 23:28:28 -04:00
|
|
|
wxTextAttr(const wxColour& colText,
|
|
|
|
const wxColour& colBack = wxNullColour,
|
2003-06-20 12:25:31 -04:00
|
|
|
const wxFont& font = wxNullFont,
|
|
|
|
wxTextAttrAlignment alignment = wxTEXT_ALIGNMENT_DEFAULT);
|
|
|
|
|
|
|
|
// operations
|
|
|
|
void Init();
|
|
|
|
|
2006-05-06 12:16:25 -04:00
|
|
|
// merges the attributes of the base and the overlay objects and returns
|
|
|
|
// the result; the parameter attributes take precedence
|
|
|
|
//
|
|
|
|
// WARNING: the order of arguments is the opposite of Combine()
|
|
|
|
static wxTextAttr Merge(const wxTextAttr& base, const wxTextAttr& overlay)
|
|
|
|
{
|
|
|
|
return Combine(overlay, base, NULL);
|
|
|
|
}
|
|
|
|
|
|
|
|
// merges the attributes of this object and overlay
|
|
|
|
void Merge(const wxTextAttr& overlay)
|
|
|
|
{
|
|
|
|
*this = Merge(*this, overlay);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2003-06-20 12:25:31 -04:00
|
|
|
// operators
|
|
|
|
void operator= (const wxTextAttr& attr);
|
2001-05-26 23:28:28 -04:00
|
|
|
|
|
|
|
// setters
|
2003-06-20 12:25:31 -04:00
|
|
|
void SetTextColour(const wxColour& colText) { m_colText = colText; m_flags |= wxTEXT_ATTR_TEXT_COLOUR; }
|
|
|
|
void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; m_flags |= wxTEXT_ATTR_BACKGROUND_COLOUR; }
|
|
|
|
void SetFont(const wxFont& font, long flags = wxTEXT_ATTR_FONT) { m_font = font; m_flags |= flags; }
|
|
|
|
void SetAlignment(wxTextAttrAlignment alignment) { m_textAlignment = alignment; m_flags |= wxTEXT_ATTR_ALIGNMENT; }
|
|
|
|
void SetTabs(const wxArrayInt& tabs) { m_tabs = tabs; m_flags |= wxTEXT_ATTR_TABS; }
|
2004-05-15 14:17:14 -04:00
|
|
|
void SetLeftIndent(int indent, int subIndent = 0) { m_leftIndent = indent; m_leftSubIndent = subIndent; m_flags |= wxTEXT_ATTR_LEFT_INDENT; }
|
2003-06-20 12:25:31 -04:00
|
|
|
void SetRightIndent(int indent) { m_rightIndent = indent; m_flags |= wxTEXT_ATTR_RIGHT_INDENT; }
|
|
|
|
void SetFlags(long flags) { m_flags = flags; }
|
2001-05-26 23:28:28 -04:00
|
|
|
|
|
|
|
// accessors
|
2003-06-20 12:25:31 -04:00
|
|
|
bool HasTextColour() const { return m_colText.Ok() && HasFlag(wxTEXT_ATTR_TEXT_COLOUR) ; }
|
|
|
|
bool HasBackgroundColour() const { return m_colBack.Ok() && HasFlag(wxTEXT_ATTR_BACKGROUND_COLOUR) ; }
|
|
|
|
bool HasFont() const { return m_font.Ok() && HasFlag(wxTEXT_ATTR_FONT) ; }
|
|
|
|
bool HasAlignment() const { return (m_textAlignment != wxTEXT_ALIGNMENT_DEFAULT) || ((m_flags & wxTEXT_ATTR_ALIGNMENT) != 0) ; }
|
|
|
|
bool HasTabs() const { return (m_flags & wxTEXT_ATTR_TABS) != 0 ; }
|
|
|
|
bool HasLeftIndent() const { return (m_flags & wxTEXT_ATTR_LEFT_INDENT) != 0 ; }
|
|
|
|
bool HasRightIndent() const { return (m_flags & wxTEXT_ATTR_RIGHT_INDENT) != 0 ; }
|
|
|
|
bool HasFlag(long flag) const { return (m_flags & flag) != 0; }
|
2001-05-26 23:28:28 -04:00
|
|
|
|
|
|
|
const wxColour& GetTextColour() const { return m_colText; }
|
|
|
|
const wxColour& GetBackgroundColour() const { return m_colBack; }
|
|
|
|
const wxFont& GetFont() const { return m_font; }
|
2003-06-20 12:25:31 -04:00
|
|
|
wxTextAttrAlignment GetAlignment() const { return m_textAlignment; }
|
|
|
|
const wxArrayInt& GetTabs() const { return m_tabs; }
|
|
|
|
long GetLeftIndent() const { return m_leftIndent; }
|
2004-05-15 14:17:14 -04:00
|
|
|
long GetLeftSubIndent() const { return m_leftSubIndent; }
|
2003-06-20 12:25:31 -04:00
|
|
|
long GetRightIndent() const { return m_rightIndent; }
|
|
|
|
long GetFlags() const { return m_flags; }
|
2001-05-26 23:28:28 -04:00
|
|
|
|
2001-06-18 13:41:33 -04:00
|
|
|
// returns false if we have any attributes set, true otherwise
|
|
|
|
bool IsDefault() const
|
|
|
|
{
|
2003-06-20 12:25:31 -04:00
|
|
|
return !HasTextColour() && !HasBackgroundColour() && !HasFont() && !HasAlignment() &&
|
|
|
|
!HasTabs() && !HasLeftIndent() && !HasRightIndent() ;
|
2001-06-18 13:41:33 -04:00
|
|
|
}
|
|
|
|
|
2001-11-26 09:50:50 -05:00
|
|
|
// return the attribute having the valid font and colours: it uses the
|
|
|
|
// attributes set in attr and falls back first to attrDefault and then to
|
|
|
|
// the text control font/colours for those attributes which are not set
|
|
|
|
static wxTextAttr Combine(const wxTextAttr& attr,
|
|
|
|
const wxTextAttr& attrDef,
|
|
|
|
const wxTextCtrlBase *text);
|
|
|
|
|
2001-05-26 23:28:28 -04:00
|
|
|
private:
|
2003-06-20 12:25:31 -04:00
|
|
|
long m_flags;
|
|
|
|
wxColour m_colText,
|
|
|
|
m_colBack;
|
|
|
|
wxFont m_font;
|
|
|
|
wxTextAttrAlignment m_textAlignment;
|
|
|
|
wxArrayInt m_tabs; // array of int: tab stops in 1/10 mm
|
|
|
|
int m_leftIndent; // left indent in 1/10 mm
|
2004-09-23 14:20:56 -04:00
|
|
|
int m_leftSubIndent; // left indent for all but the first
|
2004-05-15 14:17:14 -04:00
|
|
|
// line in a paragraph relative to the
|
|
|
|
// first line, in 1/10 mm
|
2003-06-20 12:25:31 -04:00
|
|
|
int m_rightIndent; // right indent in 1/10 mm
|
2001-05-26 23:28:28 -04:00
|
|
|
};
|
|
|
|
|
1999-07-14 18:55:57 -04:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// wxTextCtrl: a single or multiple line text zone where user can enter and
|
|
|
|
// edit text
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
class WXDLLEXPORT wxTextCtrlBase : public wxControl
|
2005-04-13 13:51:16 -04:00
|
|
|
#if wxHAS_TEXT_WINDOW_STREAM
|
2001-08-24 08:20:07 -04:00
|
|
|
, public wxSTD streambuf
|
1999-07-14 18:55:57 -04:00
|
|
|
#endif
|
|
|
|
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
// creation
|
|
|
|
// --------
|
|
|
|
|
2004-10-18 01:56:07 -04:00
|
|
|
wxTextCtrlBase(){}
|
2006-09-05 16:47:48 -04:00
|
|
|
virtual ~wxTextCtrlBase(){}
|
1999-07-14 18:55:57 -04:00
|
|
|
|
|
|
|
// accessors
|
|
|
|
// ---------
|
|
|
|
|
|
|
|
virtual wxString GetValue() const = 0;
|
|
|
|
virtual void SetValue(const wxString& value) = 0;
|
|
|
|
|
2002-01-08 20:32:02 -05:00
|
|
|
virtual wxString GetRange(long from, long to) const;
|
|
|
|
|
1999-07-14 18:55:57 -04:00
|
|
|
virtual int GetLineLength(long lineNo) const = 0;
|
|
|
|
virtual wxString GetLineText(long lineNo) const = 0;
|
|
|
|
virtual int GetNumberOfLines() const = 0;
|
|
|
|
|
|
|
|
virtual bool IsModified() const = 0;
|
|
|
|
virtual bool IsEditable() const = 0;
|
|
|
|
|
2002-07-21 14:51:04 -04:00
|
|
|
// more readable flag testing methods
|
2005-03-17 07:43:15 -05:00
|
|
|
bool IsSingleLine() const { return !HasFlag(wxTE_MULTILINE); }
|
2002-07-21 14:51:04 -04:00
|
|
|
bool IsMultiLine() const { return !IsSingleLine(); }
|
|
|
|
|
1999-07-14 18:55:57 -04:00
|
|
|
// If the return values from and to are the same, there is no selection.
|
|
|
|
virtual void GetSelection(long* from, long* to) const = 0;
|
|
|
|
|
2001-11-13 22:50:11 -05:00
|
|
|
virtual wxString GetStringSelection() const;
|
2001-11-13 20:27:16 -05:00
|
|
|
|
1999-07-14 18:55:57 -04:00
|
|
|
// operations
|
|
|
|
// ----------
|
|
|
|
|
|
|
|
// editing
|
|
|
|
virtual void Clear() = 0;
|
|
|
|
virtual void Replace(long from, long to, const wxString& value) = 0;
|
|
|
|
virtual void Remove(long from, long to) = 0;
|
|
|
|
|
2006-09-24 07:40:33 -04:00
|
|
|
// load/save the control's contents from/to a file
|
|
|
|
bool LoadFile(const wxString& file, int fileType = wxTEXT_TYPE_ANY) { return DoLoadFile(file, fileType); }
|
|
|
|
bool SaveFile(const wxString& file = wxEmptyString, int fileType = wxTEXT_TYPE_ANY);
|
|
|
|
|
|
|
|
// implementation for loading/saving
|
|
|
|
virtual bool DoLoadFile(const wxString& file, int fileType);
|
|
|
|
virtual bool DoSaveFile(const wxString& file, int fileType);
|
1999-07-14 18:55:57 -04:00
|
|
|
|
2003-09-22 20:09:18 -04:00
|
|
|
// sets/clears the dirty flag
|
|
|
|
virtual void MarkDirty() = 0;
|
1999-07-14 18:55:57 -04:00
|
|
|
virtual void DiscardEdits() = 0;
|
2006-06-25 20:39:32 -04:00
|
|
|
void SetModified(bool modified)
|
|
|
|
{
|
|
|
|
if ( modified )
|
|
|
|
MarkDirty();
|
|
|
|
else
|
|
|
|
DiscardEdits();
|
|
|
|
}
|
1999-07-14 18:55:57 -04:00
|
|
|
|
2001-08-15 08:45:53 -04:00
|
|
|
// set the max number of characters which may be entered in a single line
|
|
|
|
// text control
|
|
|
|
virtual void SetMaxLength(unsigned long WXUNUSED(len)) { }
|
|
|
|
|
1999-07-14 18:55:57 -04:00
|
|
|
// writing text inserts it at the current position, appending always
|
|
|
|
// inserts it at the end
|
|
|
|
virtual void WriteText(const wxString& text) = 0;
|
|
|
|
virtual void AppendText(const wxString& text) = 0;
|
|
|
|
|
2002-04-07 18:29:04 -04:00
|
|
|
// insert the character which would have resulted from this key event,
|
2004-09-23 14:20:56 -04:00
|
|
|
// return true if anything has been inserted
|
2002-04-07 18:29:04 -04:00
|
|
|
virtual bool EmulateKeyPress(const wxKeyEvent& event);
|
|
|
|
|
2001-05-26 23:28:28 -04:00
|
|
|
// text control under some platforms supports the text styles: these
|
|
|
|
// methods allow to apply the given text style to the given selection or to
|
|
|
|
// set/get the style which will be used for all appended text
|
|
|
|
virtual bool SetStyle(long start, long end, const wxTextAttr& style);
|
2003-06-20 12:25:31 -04:00
|
|
|
virtual bool GetStyle(long position, wxTextAttr& style);
|
2001-05-26 23:28:28 -04:00
|
|
|
virtual bool SetDefaultStyle(const wxTextAttr& style);
|
|
|
|
virtual const wxTextAttr& GetDefaultStyle() const;
|
|
|
|
|
1999-07-14 18:55:57 -04:00
|
|
|
// translate between the position (which is just an index in the text ctrl
|
|
|
|
// considering all its contents as a single strings) and (x, y) coordinates
|
|
|
|
// which represent column and line.
|
|
|
|
virtual long XYToPosition(long x, long y) const = 0;
|
1999-07-15 09:42:27 -04:00
|
|
|
virtual bool PositionToXY(long pos, long *x, long *y) const = 0;
|
1999-07-14 18:55:57 -04:00
|
|
|
|
|
|
|
virtual void ShowPosition(long pos) = 0;
|
|
|
|
|
2004-02-04 09:56:14 -05:00
|
|
|
// find the character at position given in pixels
|
|
|
|
//
|
|
|
|
// NB: pt is in device coords (not adjusted for the client area origin nor
|
|
|
|
// scrolling)
|
2004-07-23 14:07:40 -04:00
|
|
|
virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
|
2004-02-04 09:56:14 -05:00
|
|
|
virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
|
|
|
|
wxTextCoord *col,
|
|
|
|
wxTextCoord *row) const;
|
|
|
|
|
1999-07-14 18:55:57 -04:00
|
|
|
// Clipboard operations
|
|
|
|
virtual void Copy() = 0;
|
|
|
|
virtual void Cut() = 0;
|
|
|
|
virtual void Paste() = 0;
|
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
virtual bool CanCopy() const;
|
|
|
|
virtual bool CanCut() const;
|
|
|
|
virtual bool CanPaste() const;
|
1999-07-14 18:55:57 -04:00
|
|
|
|
|
|
|
// Undo/redo
|
|
|
|
virtual void Undo() = 0;
|
|
|
|
virtual void Redo() = 0;
|
|
|
|
|
|
|
|
virtual bool CanUndo() const = 0;
|
|
|
|
virtual bool CanRedo() const = 0;
|
|
|
|
|
|
|
|
// Insertion point
|
|
|
|
virtual void SetInsertionPoint(long pos) = 0;
|
|
|
|
virtual void SetInsertionPointEnd() = 0;
|
|
|
|
virtual long GetInsertionPoint() const = 0;
|
2005-01-19 11:25:34 -05:00
|
|
|
virtual wxTextPos GetLastPosition() const = 0;
|
1999-07-14 18:55:57 -04:00
|
|
|
|
|
|
|
virtual void SetSelection(long from, long to) = 0;
|
2001-06-26 16:59:19 -04:00
|
|
|
virtual void SelectAll();
|
1999-07-14 18:55:57 -04:00
|
|
|
virtual void SetEditable(bool editable) = 0;
|
|
|
|
|
|
|
|
// stream-like insertion operators: these are always available, whether we
|
|
|
|
// were, or not, compiled with streambuf support
|
|
|
|
wxTextCtrl& operator<<(const wxString& s);
|
|
|
|
wxTextCtrl& operator<<(int i);
|
|
|
|
wxTextCtrl& operator<<(long i);
|
|
|
|
wxTextCtrl& operator<<(float f);
|
|
|
|
wxTextCtrl& operator<<(double d);
|
1999-07-22 13:51:54 -04:00
|
|
|
wxTextCtrl& operator<<(const wxChar c);
|
1999-07-14 18:55:57 -04:00
|
|
|
|
2003-07-09 06:15:21 -04:00
|
|
|
// do the window-specific processing after processing the update event
|
2003-10-16 06:00:12 -04:00
|
|
|
virtual void DoUpdateWindowUI(wxUpdateUIEvent& event);
|
|
|
|
|
|
|
|
virtual bool ShouldInheritColours() const { return false; }
|
2003-07-09 06:15:21 -04:00
|
|
|
|
2000-01-17 20:22:56 -05:00
|
|
|
protected:
|
2006-02-08 16:47:09 -05:00
|
|
|
// override streambuf method
|
|
|
|
#if wxHAS_TEXT_WINDOW_STREAM
|
|
|
|
int overflow(int i);
|
|
|
|
#endif // wxHAS_TEXT_WINDOW_STREAM
|
|
|
|
|
1999-07-14 18:55:57 -04:00
|
|
|
// the name of the last file loaded with LoadFile() which will be used by
|
|
|
|
// SaveFile() by default
|
|
|
|
wxString m_filename;
|
2000-02-17 13:23:41 -05:00
|
|
|
|
2001-05-26 23:28:28 -04:00
|
|
|
// the text style which will be used for any new text added to the control
|
|
|
|
wxTextAttr m_defaultStyle;
|
2003-07-21 20:24:07 -04:00
|
|
|
|
|
|
|
DECLARE_NO_COPY_CLASS(wxTextCtrlBase)
|
2006-07-02 03:41:02 -04:00
|
|
|
DECLARE_ABSTRACT_CLASS(wxTextCtrlBase)
|
1999-07-14 18:55:57 -04:00
|
|
|
};
|
|
|
|
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// include the platform-dependent class definition
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
2002-04-01 06:41:59 -05:00
|
|
|
#if defined(__WXX11__)
|
|
|
|
#include "wx/x11/textctrl.h"
|
|
|
|
#elif defined(__WXUNIVERSAL__)
|
2001-06-26 16:59:19 -04:00
|
|
|
#include "wx/univ/textctrl.h"
|
2004-09-29 04:03:26 -04:00
|
|
|
#elif defined(__SMARTPHONE__) && defined(__WXWINCE__)
|
2004-09-08 02:20:42 -04:00
|
|
|
#include "wx/msw/wince/textctrlce.h"
|
2001-06-26 16:59:19 -04:00
|
|
|
#elif defined(__WXMSW__)
|
1999-07-14 18:55:57 -04:00
|
|
|
#include "wx/msw/textctrl.h"
|
1998-07-10 10:15:17 -04:00
|
|
|
#elif defined(__WXMOTIF__)
|
1999-07-14 18:55:57 -04:00
|
|
|
#include "wx/motif/textctrl.h"
|
2006-01-22 22:27:34 -05:00
|
|
|
#elif defined(__WXGTK20__)
|
1999-07-14 18:55:57 -04:00
|
|
|
#include "wx/gtk/textctrl.h"
|
2006-01-22 22:27:34 -05:00
|
|
|
#elif defined(__WXGTK__)
|
|
|
|
#include "wx/gtk1/textctrl.h"
|
1998-08-14 20:23:28 -04:00
|
|
|
#elif defined(__WXMAC__)
|
1999-07-14 18:55:57 -04:00
|
|
|
#include "wx/mac/textctrl.h"
|
2003-03-22 01:18:36 -05:00
|
|
|
#elif defined(__WXCOCOA__)
|
|
|
|
#include "wx/cocoa/textctrl.h"
|
1999-07-27 23:38:12 -04:00
|
|
|
#elif defined(__WXPM__)
|
|
|
|
#include "wx/os2/textctrl.h"
|
1998-05-20 10:01:55 -04:00
|
|
|
#endif
|
|
|
|
|
2001-07-29 18:40:21 -04:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// wxTextCtrl events
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
2001-07-31 13:56:45 -04:00
|
|
|
#if !WXWIN_COMPATIBILITY_EVENT_TYPES
|
|
|
|
|
2001-07-29 18:40:21 -04:00
|
|
|
BEGIN_DECLARE_EVENT_TYPES()
|
|
|
|
DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED, 7)
|
|
|
|
DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER, 8)
|
|
|
|
DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL, 13)
|
2001-08-15 08:45:53 -04:00
|
|
|
DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN, 14)
|
2001-07-29 18:40:21 -04:00
|
|
|
END_DECLARE_EVENT_TYPES()
|
|
|
|
|
2001-07-31 13:56:45 -04:00
|
|
|
#endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
|
|
|
|
|
2001-07-29 18:40:21 -04:00
|
|
|
class WXDLLEXPORT wxTextUrlEvent : public wxCommandEvent
|
|
|
|
{
|
|
|
|
public:
|
2003-03-20 21:58:55 -05:00
|
|
|
wxTextUrlEvent(int winid, const wxMouseEvent& evtMouse,
|
2001-07-29 18:40:21 -04:00
|
|
|
long start, long end)
|
2003-03-20 21:58:55 -05:00
|
|
|
: wxCommandEvent(wxEVT_COMMAND_TEXT_URL, winid)
|
2002-05-03 15:41:22 -04:00
|
|
|
, m_evtMouse(evtMouse), m_start(start), m_end(end)
|
|
|
|
{ }
|
2001-07-29 18:40:21 -04:00
|
|
|
|
|
|
|
// get the mouse event which happend over the URL
|
|
|
|
const wxMouseEvent& GetMouseEvent() const { return m_evtMouse; }
|
|
|
|
|
|
|
|
// get the start of the URL
|
|
|
|
long GetURLStart() const { return m_start; }
|
|
|
|
|
|
|
|
// get the end of the URL
|
|
|
|
long GetURLEnd() const { return m_end; }
|
|
|
|
|
|
|
|
protected:
|
|
|
|
// the corresponding mouse event
|
|
|
|
wxMouseEvent m_evtMouse;
|
|
|
|
|
|
|
|
// the start and end indices of the URL in the text control
|
|
|
|
long m_start,
|
|
|
|
m_end;
|
|
|
|
|
|
|
|
private:
|
2003-07-21 20:24:07 -04:00
|
|
|
DECLARE_DYNAMIC_CLASS_NO_COPY(wxTextUrlEvent)
|
2001-07-29 18:40:21 -04:00
|
|
|
|
|
|
|
public:
|
|
|
|
// for wxWin RTTI only, don't use
|
2002-05-03 15:41:22 -04:00
|
|
|
wxTextUrlEvent() : m_evtMouse(), m_start(0), m_end(0) { }
|
2001-07-29 18:40:21 -04:00
|
|
|
};
|
|
|
|
|
|
|
|
typedef void (wxEvtHandler::*wxTextUrlEventFunction)(wxTextUrlEvent&);
|
|
|
|
|
2005-02-14 18:53:48 -05:00
|
|
|
#define wxTextEventHandler(func) wxCommandEventHandler(func)
|
2005-02-15 08:57:52 -05:00
|
|
|
#define wxTextUrlEventHandler(func) \
|
2005-03-09 11:29:59 -05:00
|
|
|
(wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxTextUrlEventFunction, &func)
|
2005-02-14 18:53:48 -05:00
|
|
|
|
|
|
|
#define wx__DECLARE_TEXTEVT(evt, id, fn) \
|
|
|
|
wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_ ## evt, id, wxTextEventHandler(fn))
|
|
|
|
|
2005-02-15 08:57:52 -05:00
|
|
|
#define wx__DECLARE_TEXTURLEVT(evt, id, fn) \
|
|
|
|
wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_ ## evt, id, wxTextUrlEventHandler(fn))
|
|
|
|
|
2005-02-14 18:53:48 -05:00
|
|
|
#define EVT_TEXT(id, fn) wx__DECLARE_TEXTEVT(UPDATED, id, fn)
|
|
|
|
#define EVT_TEXT_ENTER(id, fn) wx__DECLARE_TEXTEVT(ENTER, id, fn)
|
2005-02-15 08:57:52 -05:00
|
|
|
#define EVT_TEXT_URL(id, fn) wx__DECLARE_TEXTURLEVT(URL, id, fn)
|
2005-02-14 18:53:48 -05:00
|
|
|
#define EVT_TEXT_MAXLEN(id, fn) wx__DECLARE_TEXTEVT(MAXLEN, id, fn)
|
2001-07-29 18:40:21 -04:00
|
|
|
|
2005-04-13 13:51:16 -04:00
|
|
|
#if wxHAS_TEXT_WINDOW_STREAM
|
2001-10-19 12:27:15 -04:00
|
|
|
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// wxStreamToTextRedirector: this class redirects all data sent to the given
|
|
|
|
// C++ stream to the wxTextCtrl given to its ctor during its lifetime.
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
class WXDLLEXPORT wxStreamToTextRedirector
|
|
|
|
{
|
2003-09-19 18:17:38 -04:00
|
|
|
private:
|
2003-12-11 03:48:01 -05:00
|
|
|
void Init(wxTextCtrl *text)
|
2001-10-19 12:27:15 -04:00
|
|
|
{
|
|
|
|
m_sbufOld = m_ostr.rdbuf();
|
|
|
|
m_ostr.rdbuf(text);
|
|
|
|
}
|
|
|
|
|
2003-09-19 18:17:38 -04:00
|
|
|
public:
|
|
|
|
wxStreamToTextRedirector(wxTextCtrl *text)
|
|
|
|
: m_ostr(wxSTD cout)
|
|
|
|
{
|
2003-12-11 03:48:01 -05:00
|
|
|
Init(text);
|
2003-09-19 18:17:38 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
wxStreamToTextRedirector(wxTextCtrl *text, wxSTD ostream *ostr)
|
|
|
|
: m_ostr(*ostr)
|
|
|
|
{
|
2003-12-11 03:48:01 -05:00
|
|
|
Init(text);
|
2003-09-19 18:17:38 -04:00
|
|
|
}
|
|
|
|
|
2001-10-19 12:27:15 -04:00
|
|
|
~wxStreamToTextRedirector()
|
|
|
|
{
|
|
|
|
m_ostr.rdbuf(m_sbufOld);
|
|
|
|
}
|
|
|
|
|
|
|
|
private:
|
|
|
|
// the stream we're redirecting
|
|
|
|
wxSTD ostream& m_ostr;
|
|
|
|
|
|
|
|
// the old streambuf (before we changed it)
|
|
|
|
wxSTD streambuf *m_sbufOld;
|
|
|
|
};
|
|
|
|
|
2005-04-13 13:51:16 -04:00
|
|
|
#endif // wxHAS_TEXT_WINDOW_STREAM
|
2001-10-19 12:27:15 -04:00
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
#endif // wxUSE_TEXTCTRL
|
|
|
|
|
1998-05-20 10:01:55 -04:00
|
|
|
#endif
|
1998-08-14 20:23:28 -04:00
|
|
|
// _WX_TEXTCTRL_H_BASE_
|