3f66f6a5b3
This keyword is not expanded by Git which means it's not replaced with the correct revision value in the releases made using git-based scripts and it's confusing to have lines with unexpanded "$Id$" in the released files. As expanding them with Git is not that simple (it could be done with git archive and export-subst attribute) and there are not many benefits in having them in the first place, just remove all these lines. If nothing else, this will make an eventual transition to Git simpler. Closes #14487. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74602 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
333 lines
10 KiB
C++
333 lines
10 KiB
C++
///////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/textentry.h
|
|
// Purpose: declares wxTextEntry interface defining a simple text entry
|
|
// Author: Vadim Zeitlin
|
|
// Created: 2007-09-24
|
|
// Copyright: (c) 2007 Vadim Zeitlin <vadim@wxwindows.org>
|
|
// Licence: wxWindows licence
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_TEXTENTRY_H_
|
|
#define _WX_TEXTENTRY_H_
|
|
|
|
// wxTextPos is the position in the text (currently it's hardly used anywhere
|
|
// and should probably be replaced with int anyhow)
|
|
typedef long wxTextPos;
|
|
|
|
class WXDLLIMPEXP_FWD_BASE wxArrayString;
|
|
class WXDLLIMPEXP_FWD_CORE wxTextCompleter;
|
|
class WXDLLIMPEXP_FWD_CORE wxTextEntryHintData;
|
|
class WXDLLIMPEXP_FWD_CORE wxWindow;
|
|
|
|
#include "wx/filefn.h" // for wxFILE and wxDIR only
|
|
#include "wx/gdicmn.h" // for wxPoint
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxTextEntryBase
|
|
// ----------------------------------------------------------------------------
|
|
|
|
class WXDLLIMPEXP_CORE wxTextEntryBase
|
|
{
|
|
public:
|
|
wxTextEntryBase() { m_eventsBlock = 0; m_hintData = NULL; }
|
|
virtual ~wxTextEntryBase();
|
|
|
|
|
|
// accessing the value
|
|
// -------------------
|
|
|
|
// SetValue() generates a text change event, ChangeValue() doesn't
|
|
virtual void SetValue(const wxString& value)
|
|
{ DoSetValue(value, SetValue_SendEvent); }
|
|
virtual void ChangeValue(const wxString& value);
|
|
|
|
// writing text inserts it at the current position replacing any current
|
|
// selection, appending always inserts it at the end and doesn't remove any
|
|
// existing text (but it will reset the selection if there is any)
|
|
virtual void WriteText(const wxString& text) = 0;
|
|
virtual void AppendText(const wxString& text);
|
|
|
|
virtual wxString GetValue() const;
|
|
virtual wxString GetRange(long from, long to) const;
|
|
bool IsEmpty() const { return GetLastPosition() <= 0; }
|
|
|
|
|
|
// editing operations
|
|
// ------------------
|
|
|
|
virtual void Replace(long from, long to, const wxString& value);
|
|
virtual void Remove(long from, long to) = 0;
|
|
virtual void Clear() { SetValue(wxString()); }
|
|
void RemoveSelection();
|
|
|
|
|
|
// clipboard operations
|
|
// --------------------
|
|
|
|
virtual void Copy() = 0;
|
|
virtual void Cut() = 0;
|
|
virtual void Paste() = 0;
|
|
|
|
virtual bool CanCopy() const;
|
|
virtual bool CanCut() const;
|
|
virtual bool CanPaste() const;
|
|
|
|
// undo/redo
|
|
// ---------
|
|
|
|
virtual void Undo() = 0;
|
|
virtual void Redo() = 0;
|
|
|
|
virtual bool CanUndo() const = 0;
|
|
virtual bool CanRedo() const = 0;
|
|
|
|
|
|
// insertion point
|
|
// ---------------
|
|
|
|
// note that moving insertion point removes any current selection
|
|
virtual void SetInsertionPoint(long pos) = 0;
|
|
virtual void SetInsertionPointEnd() { SetInsertionPoint(-1); }
|
|
virtual long GetInsertionPoint() const = 0;
|
|
virtual long GetLastPosition() const = 0;
|
|
|
|
|
|
// selection
|
|
// ---------
|
|
|
|
virtual void SetSelection(long from, long to) = 0;
|
|
virtual void SelectAll() { SetSelection(-1, -1); }
|
|
virtual void SelectNone()
|
|
{ const long pos = GetInsertionPoint(); SetSelection(pos, pos); }
|
|
virtual void GetSelection(long *from, long *to) const = 0;
|
|
bool HasSelection() const;
|
|
virtual wxString GetStringSelection() const;
|
|
|
|
|
|
// auto-completion
|
|
// ---------------
|
|
|
|
// these functions allow to auto-complete the text already entered into the
|
|
// control using either the given fixed list of strings, the paths from the
|
|
// file system or an arbitrary user-defined completer
|
|
//
|
|
// they all return true if completion was enabled or false on error (most
|
|
// commonly meaning that this functionality is not available under the
|
|
// current platform)
|
|
|
|
bool AutoComplete(const wxArrayString& choices)
|
|
{ return DoAutoCompleteStrings(choices); }
|
|
|
|
bool AutoCompleteFileNames()
|
|
{ return DoAutoCompleteFileNames(wxFILE); }
|
|
|
|
bool AutoCompleteDirectories()
|
|
{ return DoAutoCompleteFileNames(wxDIR); }
|
|
|
|
// notice that we take ownership of the pointer and will delete it
|
|
//
|
|
// if the pointer is NULL auto-completion is disabled
|
|
bool AutoComplete(wxTextCompleter *completer)
|
|
{ return DoAutoCompleteCustom(completer); }
|
|
|
|
|
|
// status
|
|
// ------
|
|
|
|
virtual bool IsEditable() const = 0;
|
|
virtual void SetEditable(bool editable) = 0;
|
|
|
|
|
|
// set the max number of characters which may be entered in a single line
|
|
// text control
|
|
virtual void SetMaxLength(unsigned long WXUNUSED(len)) { }
|
|
|
|
|
|
// hints
|
|
// -----
|
|
|
|
// hint is the (usually greyed out) text shown in the control as long as
|
|
// it's empty and doesn't have focus, it is typically used in controls used
|
|
// for searching to let the user know what is supposed to be entered there
|
|
|
|
virtual bool SetHint(const wxString& hint);
|
|
virtual wxString GetHint() const;
|
|
|
|
|
|
// margins
|
|
// -------
|
|
|
|
// margins are the empty space between borders of control and the text
|
|
// itself. When setting margin, use value -1 to indicate that specific
|
|
// margin should not be changed.
|
|
|
|
bool SetMargins(const wxPoint& pt)
|
|
{ return DoSetMargins(pt); }
|
|
bool SetMargins(wxCoord left, wxCoord top = -1)
|
|
{ return DoSetMargins(wxPoint(left, top)); }
|
|
wxPoint GetMargins() const
|
|
{ return DoGetMargins(); }
|
|
|
|
|
|
// implementation only
|
|
// -------------------
|
|
|
|
// generate the wxEVT_TEXT event for GetEditableWindow(),
|
|
// like SetValue() does and return true if the event was processed
|
|
//
|
|
// NB: this is public for wxRichTextCtrl use only right now, do not call it
|
|
static bool SendTextUpdatedEvent(wxWindow *win);
|
|
|
|
// generate the wxEVT_TEXT event for this window
|
|
bool SendTextUpdatedEvent()
|
|
{
|
|
return SendTextUpdatedEvent(GetEditableWindow());
|
|
}
|
|
|
|
|
|
// generate the wxEVT_TEXT event for this window if the
|
|
// events are not currently disabled
|
|
void SendTextUpdatedEventIfAllowed()
|
|
{
|
|
if ( EventsAllowed() )
|
|
SendTextUpdatedEvent();
|
|
}
|
|
|
|
// this function is provided solely for the purpose of forwarding text
|
|
// change notifications state from one control to another, e.g. it can be
|
|
// used by a wxComboBox which derives from wxTextEntry if it delegates all
|
|
// of its methods to another wxTextCtrl
|
|
void ForwardEnableTextChangedEvents(bool enable)
|
|
{
|
|
// it's important to call the functions which update m_eventsBlock here
|
|
// and not just our own EnableTextChangedEvents() because our state
|
|
// (i.e. the result of EventsAllowed()) must change as well
|
|
if ( enable )
|
|
ResumeTextChangedEvents();
|
|
else
|
|
SuppressTextChangedEvents();
|
|
}
|
|
|
|
protected:
|
|
// flags for DoSetValue(): common part of SetValue() and ChangeValue() and
|
|
// also used to implement WriteText() in wxMSW
|
|
enum
|
|
{
|
|
SetValue_NoEvent = 0,
|
|
SetValue_SendEvent = 1,
|
|
SetValue_SelectionOnly = 2
|
|
};
|
|
|
|
virtual void DoSetValue(const wxString& value, int flags);
|
|
virtual wxString DoGetValue() const = 0;
|
|
|
|
// override this to return the associated window, it will be used for event
|
|
// generation and also by generic hints implementation
|
|
virtual wxWindow *GetEditableWindow() = 0;
|
|
|
|
// margins functions
|
|
virtual bool DoSetMargins(const wxPoint& pt);
|
|
virtual wxPoint DoGetMargins() const;
|
|
|
|
// the derived classes should override these virtual methods to implement
|
|
// auto-completion, they do the same thing as their public counterparts but
|
|
// have different names to allow overriding just one of them without hiding
|
|
// the other one(s)
|
|
virtual bool DoAutoCompleteStrings(const wxArrayString& WXUNUSED(choices))
|
|
{ return false; }
|
|
virtual bool DoAutoCompleteFileNames(int WXUNUSED(flags)) // wxFILE | wxDIR
|
|
{ return false; }
|
|
virtual bool DoAutoCompleteCustom(wxTextCompleter *completer);
|
|
|
|
|
|
// class which should be used to temporarily disable text change events
|
|
//
|
|
// if suppress argument in ctor is false, nothing is done
|
|
class EventsSuppressor
|
|
{
|
|
public:
|
|
EventsSuppressor(wxTextEntryBase *text, bool suppress = true)
|
|
: m_text(text),
|
|
m_suppress(suppress)
|
|
{
|
|
if ( m_suppress )
|
|
m_text->SuppressTextChangedEvents();
|
|
}
|
|
|
|
~EventsSuppressor()
|
|
{
|
|
if ( m_suppress )
|
|
m_text->ResumeTextChangedEvents();
|
|
}
|
|
|
|
private:
|
|
wxTextEntryBase *m_text;
|
|
bool m_suppress;
|
|
};
|
|
|
|
friend class EventsSuppressor;
|
|
|
|
private:
|
|
// suppress or resume the text changed events generation: don't use these
|
|
// functions directly, use EventsSuppressor class above instead
|
|
void SuppressTextChangedEvents()
|
|
{
|
|
if ( !m_eventsBlock++ )
|
|
EnableTextChangedEvents(false);
|
|
}
|
|
|
|
void ResumeTextChangedEvents()
|
|
{
|
|
if ( !--m_eventsBlock )
|
|
EnableTextChangedEvents(true);
|
|
}
|
|
|
|
|
|
// this must be overridden in the derived classes if our implementation of
|
|
// SetValue() or Replace() is used to disable (and enable back) generation
|
|
// of the text changed events
|
|
//
|
|
// initially the generation of the events is enabled
|
|
virtual void EnableTextChangedEvents(bool WXUNUSED(enable)) { }
|
|
|
|
// return true if the events are currently not suppressed
|
|
bool EventsAllowed() const { return m_eventsBlock == 0; }
|
|
|
|
|
|
// if this counter is non-null, events are blocked
|
|
unsigned m_eventsBlock;
|
|
|
|
// hint-related stuff, only allocated if/when SetHint() is used
|
|
wxTextEntryHintData *m_hintData;
|
|
|
|
// It needs to call our Do{Get,Set}Value() to work with the real control
|
|
// contents.
|
|
friend class wxTextEntryHintData;
|
|
};
|
|
|
|
#ifdef __WXUNIVERSAL__
|
|
// TODO: we need to use wxTextEntryDelegate here, but for now just prevent
|
|
// the GTK/MSW classes from being used in wxUniv build
|
|
class WXDLLIMPEXP_CORE wxTextEntry : public wxTextEntryBase
|
|
{
|
|
};
|
|
#elif defined(__WXGTK20__)
|
|
#include "wx/gtk/textentry.h"
|
|
#elif defined(__WXMAC__)
|
|
#include "wx/osx/textentry.h"
|
|
#elif defined(__WXMSW__)
|
|
#include "wx/msw/textentry.h"
|
|
#elif defined(__WXMOTIF__)
|
|
#include "wx/motif/textentry.h"
|
|
#elif defined(__WXPM__)
|
|
#include "wx/os2/textentry.h"
|
|
#else
|
|
// no platform-specific implementation of wxTextEntry yet
|
|
class WXDLLIMPEXP_CORE wxTextEntry : public wxTextEntryBase
|
|
{
|
|
};
|
|
#endif
|
|
|
|
#endif // _WX_TEXTENTRY_H_
|
|
|