4f4c5fcfdf
This is a combination of running clang-tidy with modernize-use-nullptr check for some ports (GTK, X11, OSX) and manual changes to the ports for which it couldn't be used easily (MSW, DFB) and also manually updating the docs. Also replace NULL with null or nullptr in the comments as this is more consistent with the use of nullptr in the code and makes it simpler to grep for the remaining occurrences of NULL itself. And also use null in the assert messages. Only a few occurrences of "NULL" are still left in non-C files, mostly corresponding to unclear comments or string output which it might not be safe to change.
219 lines
8 KiB
C++
219 lines
8 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/control.h
|
|
// Purpose: wxControl common interface
|
|
// Author: Vadim Zeitlin
|
|
// Modified by:
|
|
// Created: 26.07.99
|
|
// Copyright: (c) wxWidgets team
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_CONTROL_H_BASE_
|
|
#define _WX_CONTROL_H_BASE_
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// headers
|
|
// ----------------------------------------------------------------------------
|
|
|
|
#include "wx/defs.h"
|
|
|
|
#if wxUSE_CONTROLS
|
|
|
|
#include "wx/window.h" // base class
|
|
#include "wx/gdicmn.h" // wxEllipsize...
|
|
|
|
extern WXDLLIMPEXP_DATA_CORE(const char) wxControlNameStr[];
|
|
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxControl is the base class for all controls
|
|
// ----------------------------------------------------------------------------
|
|
|
|
class WXDLLIMPEXP_CORE wxControlBase : public wxWindow
|
|
{
|
|
public:
|
|
wxControlBase() { }
|
|
|
|
virtual ~wxControlBase();
|
|
|
|
// Create() function adds the validator parameter
|
|
bool Create(wxWindow *parent, wxWindowID id,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = 0,
|
|
const wxValidator& validator = wxDefaultValidator,
|
|
const wxString& name = wxASCII_STR(wxControlNameStr));
|
|
|
|
// get the control alignment (left/right/centre, top/bottom/centre)
|
|
int GetAlignment() const { return m_windowStyle & wxALIGN_MASK; }
|
|
|
|
// set label with mnemonics
|
|
virtual void SetLabel(const wxString& label) override
|
|
{
|
|
m_labelOrig = label;
|
|
|
|
InvalidateBestSize();
|
|
|
|
wxWindow::SetLabel(label);
|
|
}
|
|
|
|
// return the original string, as it was passed to SetLabel()
|
|
// (i.e. with wx-style mnemonics)
|
|
virtual wxString GetLabel() const override { return m_labelOrig; }
|
|
|
|
// set label text (mnemonics will be escaped)
|
|
virtual void SetLabelText(const wxString& text)
|
|
{
|
|
SetLabel(EscapeMnemonics(text));
|
|
}
|
|
|
|
// get just the text of the label, without mnemonic characters ('&')
|
|
virtual wxString GetLabelText() const { return GetLabelText(GetLabel()); }
|
|
|
|
|
|
#if wxUSE_MARKUP
|
|
// Set the label with markup (and mnemonics). Markup is a simple subset of
|
|
// HTML with tags such as <b>, <i> and <span>. By default it is not
|
|
// supported i.e. all the markup is simply stripped and SetLabel() is
|
|
// called but some controls in some ports do support this already and in
|
|
// the future most of them should.
|
|
//
|
|
// Notice that, being HTML-like, markup also supports XML entities so '<'
|
|
// should be encoded as "<" and so on, a bare '<' in the input will
|
|
// likely result in an error. As an exception, a bare '&' is allowed and
|
|
// indicates that the next character is a mnemonic. To insert a literal '&'
|
|
// in the control you need to use "&" in the input string.
|
|
//
|
|
// Returns true if the label was set, even if the markup in it was ignored.
|
|
// False is only returned if we failed to parse the label.
|
|
bool SetLabelMarkup(const wxString& markup)
|
|
{
|
|
return DoSetLabelMarkup(markup);
|
|
}
|
|
#endif // wxUSE_MARKUP
|
|
|
|
|
|
// controls by default inherit the colours of their parents, if a
|
|
// particular control class doesn't want to do it, it can override
|
|
// ShouldInheritColours() to return false
|
|
virtual bool ShouldInheritColours() const override { return true; }
|
|
|
|
|
|
// WARNING: this doesn't work for all controls nor all platforms!
|
|
//
|
|
// simulates the event of given type (i.e. wxButton::Command() is just as
|
|
// if the button was clicked)
|
|
virtual void Command(wxCommandEvent &event);
|
|
|
|
virtual bool SetFont(const wxFont& font) override;
|
|
|
|
// wxControl-specific processing after processing the update event
|
|
virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) override;
|
|
|
|
wxSize GetSizeFromTextSize(int xlen, int ylen = -1) const
|
|
{ return DoGetSizeFromTextSize(xlen, ylen); }
|
|
wxSize GetSizeFromTextSize(const wxSize& tsize) const
|
|
{ return DoGetSizeFromTextSize(tsize.x, tsize.y); }
|
|
|
|
wxSize GetSizeFromText(const wxString& text) const
|
|
{
|
|
return GetSizeFromTextSize(GetTextExtent(text).GetWidth());
|
|
}
|
|
|
|
|
|
// static utilities for mnemonics char (&) handling
|
|
// ------------------------------------------------
|
|
|
|
// returns the given string without mnemonic characters ('&')
|
|
static wxString GetLabelText(const wxString& label);
|
|
|
|
// returns the given string without mnemonic characters ('&')
|
|
// this function is identic to GetLabelText() and is provided for clarity
|
|
// and for symmetry with the wxStaticText::RemoveMarkup() function.
|
|
static wxString RemoveMnemonics(const wxString& str);
|
|
|
|
// escapes (by doubling them) the mnemonics
|
|
static wxString EscapeMnemonics(const wxString& str);
|
|
|
|
|
|
// miscellaneous static utilities
|
|
// ------------------------------
|
|
|
|
// replaces parts of the given (multiline) string with an ellipsis if needed
|
|
static wxString Ellipsize(const wxString& label, const wxDC& dc,
|
|
wxEllipsizeMode mode, int maxWidth,
|
|
int flags = wxELLIPSIZE_FLAGS_DEFAULT);
|
|
|
|
// return the accel index in the string or -1 if none and puts the modified
|
|
// string into second parameter if non-null
|
|
static int FindAccelIndex(const wxString& label,
|
|
wxString *labelOnly = nullptr);
|
|
|
|
// this is a helper for the derived class GetClassDefaultAttributes()
|
|
// implementation: it returns the right colours for the classes which
|
|
// contain something else (e.g. wxListBox, wxTextCtrl, ...) instead of
|
|
// being simple controls (such as wxButton, wxCheckBox, ...)
|
|
static wxVisualAttributes
|
|
GetCompositeControlsDefaultAttributes(wxWindowVariant variant);
|
|
|
|
protected:
|
|
// choose the default border for this window
|
|
virtual wxBorder GetDefaultBorder() const override;
|
|
|
|
// creates the control (calls wxWindowBase::CreateBase inside) and adds it
|
|
// to the list of parents children
|
|
bool CreateControl(wxWindowBase *parent,
|
|
wxWindowID id,
|
|
const wxPoint& pos,
|
|
const wxSize& size,
|
|
long style,
|
|
const wxValidator& validator,
|
|
const wxString& name);
|
|
|
|
#if wxUSE_MARKUP
|
|
// This function may be overridden in the derived classes to implement
|
|
// support for labels with markup. The base class version simply strips the
|
|
// markup and calls SetLabel() with the remaining text.
|
|
virtual bool DoSetLabelMarkup(const wxString& markup);
|
|
#endif // wxUSE_MARKUP
|
|
|
|
// override this to return the total control's size from a string size
|
|
virtual wxSize DoGetSizeFromTextSize(int xlen, int ylen = -1) const;
|
|
|
|
// initialize the common fields of wxCommandEvent
|
|
void InitCommandEvent(wxCommandEvent& event) const;
|
|
|
|
#if wxUSE_MARKUP
|
|
// Remove markup from the given string, returns empty string on error i.e.
|
|
// if markup was syntactically invalid.
|
|
static wxString RemoveMarkup(const wxString& markup);
|
|
#endif // wxUSE_MARKUP
|
|
|
|
|
|
// this field contains the label in wx format, i.e. with '&' mnemonics,
|
|
// as it was passed to the last SetLabel() call
|
|
wxString m_labelOrig;
|
|
|
|
wxDECLARE_NO_COPY_CLASS(wxControlBase);
|
|
};
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// include platform-dependent wxControl declarations
|
|
// ----------------------------------------------------------------------------
|
|
|
|
#if defined(__WXUNIVERSAL__)
|
|
#include "wx/univ/control.h"
|
|
#elif defined(__WXMSW__)
|
|
#include "wx/msw/control.h"
|
|
#elif defined(__WXGTK__)
|
|
#include "wx/gtk/control.h"
|
|
#elif defined(__WXMAC__)
|
|
#include "wx/osx/control.h"
|
|
#elif defined(__WXQT__)
|
|
#include "wx/qt/control.h"
|
|
#endif
|
|
|
|
#endif // wxUSE_CONTROLS
|
|
|
|
#endif
|
|
// _WX_CONTROL_H_BASE_
|