Search for usage in LXR

#include <KCharSelect>

Inheritance diagram for KCharSelect:

Public Types

enum  Control {
  SearchLine = 0x01, FontCombo = 0x02, FontSize = 0x04, BlockCombos = 0x08,
  CharacterTable = 0x10, DetailBrowser = 0x20, HistoryButtons = 0x40, AllGuiElements = 65535
typedef QFlags< ControlControls
- Public Types inherited from QWidget
enum  RenderFlag
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric


bool allPlanesEnabled
QChar currentChar
uint currentCodePoint
QFont currentFont
QList< QChardisplayedChars
QVector< uint > displayedCodePoints
- Properties inherited from QWidget
- Properties inherited from QObject


void charSelected (const QChar &c)
void codePointSelected (uint codePoint)
void currentCharChanged (const QChar &c)
void currentCodePointChanged (uint codePoint)
void currentFontChanged (const QFont &font)
void displayedCharsChanged ()

Public Slots

void setCurrentChar (const QChar &c)
void setCurrentCodePoint (uint codePoint)
void setCurrentFont (const QFont &font)

Public Member Functions

 KCharSelect (QWidget *parent, const Controls controls=AllGuiElements)
 KCharSelect (QWidget *parent, QObject *actionParent, const Controls controls=AllGuiElements)
bool allPlanesEnabled () const
QChar currentChar () const
uint currentCodePoint () const
QFont currentFont () const
QList< QChardisplayedChars () const
QVector< uint > displayedCodePoints () const
void setAllPlanesEnabled (bool all)
QSize sizeHint () const override
- Public Member Functions inherited from QWidget
 QWidget (QWidget *parent, Qt::WindowFlags f)
bool acceptDrops () const const
QString accessibleDescription () const const
QString accessibleName () const const
QList< QAction * > actions () const const
void activateWindow ()
void addAction (QAction *action)
void addActions (QList< QAction * > actions)
void adjustSize ()
bool autoFillBackground () const const
QPalette::ColorRole backgroundRole () const const
QBackingStorebackingStore () const const
QSize baseSize () const const
QWidgetchildAt (const QPoint &p) const const
QWidgetchildAt (int x, int y) const const
QRect childrenRect () const const
QRegion childrenRegion () const const
void clearFocus ()
void clearMask ()
bool close ()
QMargins contentsMargins () const const
QRect contentsRect () const const
Qt::ContextMenuPolicy contextMenuPolicy () const const
QCursor cursor () const const
void customContextMenuRequested (const QPoint &pos)
WId effectiveWinId () const const
void ensurePolished () const const
Qt::FocusPolicy focusPolicy () const const
QWidgetfocusProxy () const const
QWidgetfocusWidget () const const
const QFontfont () const const
QFontInfo fontInfo () const const
QFontMetrics fontMetrics () const const
QPalette::ColorRole foregroundRole () const const
QRect frameGeometry () const const
QSize frameSize () const const
const QRectgeometry () const const
void getContentsMargins (int *left, int *top, int *right, int *bottom) const const
QPixmap grab (const QRect &rectangle)
void grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)
void grabKeyboard ()
void grabMouse ()
void grabMouse (const QCursor &cursor)
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)
QGraphicsEffectgraphicsEffect () const const
QGraphicsProxyWidgetgraphicsProxyWidget () const const
bool hasEditFocus () const const
bool hasFocus () const const
virtual bool hasHeightForWidth () const const
bool hasMouseTracking () const const
bool hasTabletTracking () const const
int height () const const
virtual int heightForWidth (int w) const const
void hide ()
Qt::InputMethodHints inputMethodHints () const const
virtual QVariant inputMethodQuery (Qt::InputMethodQuery query) const const
void insertAction (QAction *before, QAction *action)
void insertActions (QAction *before, QList< QAction * > actions)
bool isActiveWindow () const const
bool isAncestorOf (const QWidget *child) const const
bool isEnabled () const const
bool isEnabledTo (const QWidget *ancestor) const const
bool isEnabledToTLW () const const
bool isFullScreen () const const
bool isHidden () const const
bool isMaximized () const const
bool isMinimized () const const
bool isModal () const const
bool isTopLevel () const const
bool isVisible () const const
bool isVisibleTo (const QWidget *ancestor) const const
bool isWindow () const const
bool isWindowModified () const const
QLayoutlayout () const const
Qt::LayoutDirection layoutDirection () const const
QLocale locale () const const
void lower ()
QPoint mapFrom (const QWidget *parent, const QPoint &pos) const const
QPoint mapFromGlobal (const QPoint &pos) const const
QPoint mapFromParent (const QPoint &pos) const const
QPoint mapTo (const QWidget *parent, const QPoint &pos) const const
QPoint mapToGlobal (const QPoint &pos) const const
QPoint mapToParent (const QPoint &pos) const const
QRegion mask () const const
int maximumHeight () const const
QSize maximumSize () const const
int maximumWidth () const const
int minimumHeight () const const
QSize minimumSize () const const
virtual QSize minimumSizeHint () const const
int minimumWidth () const const
void move (const QPoint &)
void move (int x, int y)
QWidgetnativeParentWidget () const const
QWidgetnextInFocusChain () const const
QRect normalGeometry () const const
void overrideWindowFlags (Qt::WindowFlags flags)
virtual QPaintEnginepaintEngine () const const override
const QPalettepalette () const const
QWidgetparentWidget () const const
QPoint pos () const const
QWidgetpreviousInFocusChain () const const
void raise ()
QRect rect () const const
void releaseKeyboard ()
void releaseMouse ()
void releaseShortcut (int id)
void removeAction (QAction *action)
void render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
void render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
void repaint ()
void repaint (const QRect &rect)
void repaint (const QRegion &rgn)
void repaint (int x, int y, int w, int h)
void resize (const QSize &)
void resize (int w, int h)
bool restoreGeometry (const QByteArray &geometry)
QByteArray saveGeometry () const const
QScreenscreen () const const
void scroll (int dx, int dy)
void scroll (int dx, int dy, const QRect &r)
void setAcceptDrops (bool on)
void setAccessibleDescription (const QString &description)
void setAccessibleName (const QString &name)
void setAttribute (Qt::WidgetAttribute attribute, bool on)
void setAutoFillBackground (bool enabled)
void setBackgroundRole (QPalette::ColorRole role)
void setBaseSize (const QSize &)
void setBaseSize (int basew, int baseh)
void setContentsMargins (const QMargins &margins)
void setContentsMargins (int left, int top, int right, int bottom)
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
void setCursor (const QCursor &)
void setDisabled (bool disable)
void setEditFocus (bool enable)
void setEnabled (bool)
void setFixedHeight (int h)
void setFixedSize (const QSize &s)
void setFixedSize (int w, int h)
void setFixedWidth (int w)
void setFocus ()
void setFocus (Qt::FocusReason reason)
void setFocusPolicy (Qt::FocusPolicy policy)
void setFocusProxy (QWidget *w)
void setFont (const QFont &)
void setForegroundRole (QPalette::ColorRole role)
void setGeometry (const QRect &)
void setGeometry (int x, int y, int w, int h)
void setGraphicsEffect (QGraphicsEffect *effect)
void setHidden (bool hidden)
void setInputMethodHints (Qt::InputMethodHints hints)
void setLayout (QLayout *layout)
void setLayoutDirection (Qt::LayoutDirection direction)
void setLocale (const QLocale &locale)
void setMask (const QBitmap &bitmap)
void setMask (const QRegion &region)
void setMaximumHeight (int maxh)
void setMaximumSize (const QSize &)
void setMaximumSize (int maxw, int maxh)
void setMaximumWidth (int maxw)
void setMinimumHeight (int minh)
void setMinimumSize (const QSize &)
void setMinimumSize (int minw, int minh)
void setMinimumWidth (int minw)
void setMouseTracking (bool enable)
void setPalette (const QPalette &)
void setParent (QWidget *parent)
void setParent (QWidget *parent, Qt::WindowFlags f)
void setShortcutAutoRepeat (int id, bool enable)
void setShortcutEnabled (int id, bool enable)
void setSizeIncrement (const QSize &)
void setSizeIncrement (int w, int h)
void setSizePolicy (QSizePolicy)
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
void setStatusTip (const QString &)
void setStyle (QStyle *style)
void setStyleSheet (const QString &styleSheet)
void setTabletTracking (bool enable)
void setToolTip (const QString &)
void setToolTipDuration (int msec)
void setUpdatesEnabled (bool enable)
void setupUi (QWidget *widget)
virtual void setVisible (bool visible)
void setWhatsThis (const QString &)
void setWindowFilePath (const QString &filePath)
void setWindowFlag (Qt::WindowType flag, bool on)
void setWindowFlags (Qt::WindowFlags type)
void setWindowIcon (const QIcon &icon)
void setWindowIconText (const QString &)
void setWindowModality (Qt::WindowModality windowModality)
void setWindowModified (bool)
void setWindowOpacity (qreal level)
void setWindowRole (const QString &role)
void setWindowState (Qt::WindowStates windowState)
void setWindowTitle (const QString &)
void show ()
void showFullScreen ()
void showMaximized ()
void showMinimized ()
void showNormal ()
QSize size () const const
QSize sizeIncrement () const const
QSizePolicy sizePolicy () const const
void stackUnder (QWidget *w)
QString statusTip () const const
QStylestyle () const const
QString styleSheet () const const
bool testAttribute (Qt::WidgetAttribute attribute) const const
QString toolTip () const const
int toolTipDuration () const const
QWidgettopLevelWidget () const const
bool underMouse () const const
void ungrabGesture (Qt::GestureType gesture)
void unsetCursor ()
void unsetLayoutDirection ()
void unsetLocale ()
void update ()
void update (const QRect &rect)
void update (const QRegion &rgn)
void update (int x, int y, int w, int h)
void updateGeometry ()
bool updatesEnabled () const const
QRegion visibleRegion () const const
QString whatsThis () const const
int width () const const
QWidgetwindow () const const
QString windowFilePath () const const
Qt::WindowFlags windowFlags () const const
QWindowwindowHandle () const const
QIcon windowIcon () const const
void windowIconChanged (const QIcon &icon)
QString windowIconText () const const
void windowIconTextChanged (const QString &iconText)
Qt::WindowModality windowModality () const const
qreal windowOpacity () const const
QString windowRole () const const
Qt::WindowStates windowState () const const
QString windowTitle () const const
void windowTitleChanged (const QString &title)
Qt::WindowType windowType () const const
WId winId () const const
int x () const const
int y () const const
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
bool blockSignals (bool block)
const QObjectListchildren () const const
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void deleteLater ()
void destroyed (QObject *obj)
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool disconnect (const QObject *receiver, const char *method) const const
void dumpObjectInfo ()
void dumpObjectInfo () const const
void dumpObjectTree ()
void dumpObjectTree () const const
QList< QByteArraydynamicPropertyNames () const const
virtual bool eventFilter (QObject *watched, QEvent *event)
findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
bool inherits (const char *className) const const
void installEventFilter (QObject *filterObj)
bool isWidgetType () const const
bool isWindowType () const const
void killTimer (int id)
virtual const QMetaObjectmetaObject () const const
void moveToThread (QThread *targetThread)
QString objectName () const const
void objectNameChanged (const QString &objectName)
QObjectparent () const const
QVariant property (const char *name) const const
 Q_CLASSINFO (Name, Value)
 Q_ENUM (...)
 Q_ENUM_NS (...)
 Q_ENUMS (...)
 Q_FLAG (...)
 Q_FLAG_NS (...)
 Q_FLAGS (...)
qFindChild (const QObject *obj, const QString &name)
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
QList< T > qFindChildren (const QObject *obj, const QString &name)
qobject_cast (const QObject *object)
qobject_cast (QObject *object)
void removeEventFilter (QObject *obj)
void setObjectName (const QString &name)
void setParent (QObject *parent)
bool setProperty (const char *name, const QVariant &value)
bool signalsBlocked () const const
int startTimer (int interval, Qt::TimerType timerType)
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
QThreadthread () const const
- Public Member Functions inherited from QPaintDevice
int colorCount () const const
int depth () const const
int devicePixelRatio () const const
qreal devicePixelRatioF () const const
int height () const const
int heightMM () const const
int logicalDpiX () const const
int logicalDpiY () const const
bool paintingActive () const const
int physicalDpiX () const const
int physicalDpiY () const const
int width () const const
int widthMM () const const

Additional Inherited Members

- Static Public Member Functions inherited from QWidget
QWidgetcreateWindowContainer (QWindow *window, QWidget *parent, Qt::WindowFlags flags)
QWidgetfind (WId id)
QWidgetkeyboardGrabber ()
QWidgetmouseGrabber ()
void setTabOrder (QWidget *first, QWidget *second)
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool disconnect (const QMetaObject::Connection &connection)
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString tr (const char *sourceText, const char *disambiguation, int n)
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
- Public Attributes inherited from QWidget
typedef RenderFlags
- Public Attributes inherited from QObject
typedef QObjectList
- Public Attributes inherited from QPaintDevice
- Protected Member Functions inherited from QWidget
virtual void actionEvent (QActionEvent *event)
virtual void changeEvent (QEvent *event)
virtual void closeEvent (QCloseEvent *event)
virtual void contextMenuEvent (QContextMenuEvent *event)
void create (WId window, bool initializeWindow, bool destroyOldWindow)
void destroy (bool destroyWindow, bool destroySubWindows)
virtual void dragEnterEvent (QDragEnterEvent *event)
virtual void dragLeaveEvent (QDragLeaveEvent *event)
virtual void dragMoveEvent (QDragMoveEvent *event)
virtual void dropEvent (QDropEvent *event)
virtual void enterEvent (QEvent *event)
virtual bool event (QEvent *event) override
virtual void focusInEvent (QFocusEvent *event)
bool focusNextChild ()
virtual bool focusNextPrevChild (bool next)
virtual void focusOutEvent (QFocusEvent *event)
bool focusPreviousChild ()
virtual void hideEvent (QHideEvent *event)
virtual void initPainter (QPainter *painter) const const override
virtual void inputMethodEvent (QInputMethodEvent *event)
virtual void keyPressEvent (QKeyEvent *event)
virtual void keyReleaseEvent (QKeyEvent *event)
virtual void leaveEvent (QEvent *event)
virtual int metric (QPaintDevice::PaintDeviceMetric m) const const override
virtual void mouseDoubleClickEvent (QMouseEvent *event)
virtual void mouseMoveEvent (QMouseEvent *event)
virtual void mousePressEvent (QMouseEvent *event)
virtual void mouseReleaseEvent (QMouseEvent *event)
virtual void moveEvent (QMoveEvent *event)
virtual bool nativeEvent (const QByteArray &eventType, void *message, long *result)
virtual void paintEvent (QPaintEvent *event)
virtual void resizeEvent (QResizeEvent *event)
virtual void showEvent (QShowEvent *event)
virtual void tabletEvent (QTabletEvent *event)
void updateMicroFocus ()
virtual void wheelEvent (QWheelEvent *event)
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
virtual void connectNotify (const QMetaMethod &signal)
virtual void customEvent (QEvent *event)
virtual void disconnectNotify (const QMetaMethod &signal)
bool isSignalConnected (const QMetaMethod &signal) const const
int receivers (const char *signal) const const
QObjectsender () const const
int senderSignalIndex () const const
virtual void timerEvent (QTimerEvent *event)

Detailed Description

Character selection widget.

This widget allows the user to select a character of a specified font and to browse Unicode information

KCharSelect Widget

You can specify the font whose characters should be displayed via setCurrentFont(). Using the Controls argument in the constructor you can create a compact version of KCharSelect if there is not enough space and if you don't need all features.

KCharSelect displays one Unicode block at a time and provides categorized access to them. Unicode character names and further details, including cross references, are displayed. Additionally, there is a search to find characters.

By default, KCharSelect is restricted to Basic Multilingual Plane (BMP) characters that QChar supports, i.e. characters with code points that fit into a quint16 (U+0000..U+FFFF). API methods that have a QChar argument can only be used for this default mode:

To get the current selected character, use the currentChar() method. You can set the character which should be displayed with setCurrentChar().

If you want the user to select and search characters from all planes, i.e. characters U+0000..U+10FFFF, use setAllPlanesEnabled(true) and use the uint based methods currentCodePoint() and setCurrentCodePoint() instead.

Since QString does not allow uint code points, you either must use QString::fromUcs4() and QString::ToUcs4() to convert between strings and code points, or manually do the surrogate pair handling using QChar::requiresSurrogates() and friends.

Reginald Stadlbauer reggi[email protected][email protected][email protected]e.org
Daniel Laidig d.lai[email protected][email protected][email protected]gmx.d[email protected]e

Definition at line 60 of file kcharselect.h.

Member Typedef Documentation

◆ Controls

Stores a combination of Control values.

Definition at line 112 of file kcharselect.h.

Member Enumeration Documentation

◆ Control

Flags to set the shown widgets.

See also

Shows the search widgets.


Shows the font combo box.


Shows the font size spin box.


Shows the category/block selection combo boxes.


Shows the actual table.


Shows the detail browser.


Shows the Back/Forward buttons.


Shows everything.

Definition at line 75 of file kcharselect.h.

Constructor & Destructor Documentation

◆ KCharSelect() [1/2]

KCharSelect::KCharSelect ( QWidget parent,
const Controls  controls = AllGuiElements 


controls can be used to show a custom set of widgets.

parentthe parent widget for this KCharSelect (see QWidget documentation)
controlsselects the visible controls on the KCharSelect widget

Definition at line 348 of file kcharselect.cpp.

◆ KCharSelect() [2/2]

KCharSelect::KCharSelect ( QWidget parent,
QObject actionParent,
const Controls  controls = AllGuiElements 


controls can be used to show a custom set of widgets.

The widget uses the following actions:

  • KStandardActions::find() (edit_find)
  • KStandardActions::back() (go_back)
  • KStandardActions::forward() (go_forward)

If you provide a KActionCollection, this will be populated with the above actions, which you can then manually trigger or place in menus and toolbars.

parentthe parent widget for this KCharSelect (see QWidget documentation)
actionParentif this is not null, KCharSelect will place its actions into this collection
controlsselects the visible controls on the KCharSelect widget

Definition at line 355 of file kcharselect.cpp.

Member Function Documentation

◆ allPlanesEnabled()

bool KCharSelect::allPlanesEnabled ( ) const
true, if characters from all Unicode code planes can be selected.

◆ charSelected

void KCharSelect::charSelected ( const QChar c)

A character is selected to be inserted somewhere.

cthe selected character

◆ codePointSelected

void KCharSelect::codePointSelected ( uint  codePoint)

A character is selected to be inserted somewhere.

codePointthe Unicode code point of the selected character

◆ currentChar()

QChar KCharSelect::currentChar ( ) const

Returns the currently selected character.

If characters outside the Basic Multilingual Plane (BMP) can be selected, use currentCodePoint instead.

See also

◆ currentCharChanged

void KCharSelect::currentCharChanged ( const QChar c)

The current character is changed.

cthe new character

◆ currentCodePoint()

uint KCharSelect::currentCodePoint ( ) const

Returns the Unicode code point of the currently selected character.

If you enabled support for all Unicode planes, you must use QChar::requiresSurrogates() to check if the code point requires conversion to a UTF-16 surrogate pair before converting it to QString. You cannot convert a code point to a QChar.

◆ currentCodePointChanged

void KCharSelect::currentCodePointChanged ( uint  codePoint)

The current character is changed.

codePointthe Unicode code point of the new character

◆ currentFont()

QFont KCharSelect::currentFont ( ) const

Returns the currently displayed font.

◆ currentFontChanged

void KCharSelect::currentFontChanged ( const QFont font)

A new font is selected or the font size changed.

fontthe new font

◆ displayedChars()

QList<QChar> KCharSelect::displayedChars ( ) const

Returns a list of currently displayed characters.

If characters outside the Basic Multilingual Plane (BMP) can be selected, use displayedCodePoints instead. Warning: this method can be a bit slow

See also

◆ displayedCharsChanged

void KCharSelect::displayedCharsChanged ( )

The currently displayed characters are changed (search results or block).

◆ displayedCodePoints()

QVector<uint> KCharSelect::displayedCodePoints ( ) const

Returns a list of Unicode code points of the currently displayed characters.


◆ setAllPlanesEnabled()

void KCharSelect::setAllPlanesEnabled ( bool  all)

Sets the allowed Unicode code planes.

If all is false, then only characters from the Basic Multilingual Plane (BMP) can be selected, otherwise characters from all planes are allowed.

For compatibility reasons, the default is false.

If you enable support for all planes, you must use the functions handling uint code points instead of QChar characters.


Definition at line 587 of file kcharselect.cpp.

◆ setCurrentChar

void KCharSelect::setCurrentChar ( const QChar c)

Highlights the character c.

If the character is not displayed, the block is changed.

cthe character to highlight

Definition at line 634 of file kcharselect.cpp.

◆ setCurrentCodePoint

void KCharSelect::setCurrentCodePoint ( uint  codePoint)

Highlights the character with the specified codePoint.

If the character is outside the Basic Multilingual Plane (BMP), then you must enable support for all planes for this to work.

codePointthe Unicode code point of the character to highlight
See also

Definition at line 642 of file kcharselect.cpp.

◆ setCurrentFont

void KCharSelect::setCurrentFont ( const QFont font)

Sets the font which is displayed to font.

fontthe display font for the widget

Definition at line 580 of file kcharselect.cpp.

◆ sizeHint()

QSize KCharSelect::sizeHint ( ) const


Reimplemented from QWidget.

Definition at line 575 of file kcharselect.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon May 8 2023 04:01:28 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.