| Wireshark 4.7.3 The Wireshark network protocol analyzer

Loading...
Searching...
No Matches
Public Slots | Public Member Functions | Protected Member Functions | List of all members
DissectorSyntaxLineEdit Class Reference

A line edit widget that provides syntax validation and auto-completion for dissector names. More...

`#include <dissector_syntax_line_edit.h>`

Inheritance diagram for DissectorSyntaxLineEdit:

## Public Slots
void | checkDissectorName (const QString &dissector)
| Validates the syntax of the provided dissector name string.
Public Slots inherited from SyntaxLineEdit
void | setStyleSheet (const QString &style_sheet)
| Sets the base style sheet; the state-driven style is composited on top.
void | insertFilter (const QString &filter)
| Inserts filter text at the cursor position, adding surrounding spaces where necessary to keep the expression well-formed.
bool | checkDisplayFilter (QString filter)
| Validates `filter` as a Wireshark display filter and updates the syntax state and error message accordingly.
void | checkFieldName (QString field)
| Validates `field` as a protocol field name and updates the syntax state.
void | checkCustomColumn (QString fields)
| Validates `fields` as a custom-column field expression and updates the syntax state.
void | checkInteger (QString number)
| Validates `number` as a well-formed integer and updates the syntax state.

## Public Member Functions
| DissectorSyntaxLineEdit (QWidget *parent=0)
| Constructs a new DissectorSyntaxLineEdit widget.
void | updateDissectorNames ()
| Updates the internal list of available dissector names used for validation and completion.
void | setDefaultPlaceholderText ()
| Sets the default placeholder text for the line edit widget.
Public Member Functions inherited from SyntaxLineEdit
| SyntaxLineEdit (QWidget *parent=0)
| Constructs the SyntaxLineEdit in the Empty state with no completer.
SyntaxState | syntaxState () const
| Returns the current syntax validation state.
void | setSyntaxState (SyntaxState state=Empty)
| Sets the syntax state and updates the widget's style sheet to reflect it.
QString | syntaxErrorMessage ()
| Returns a short, human-readable description of the current syntax error.
QString | syntaxErrorMessageFull ()
| Returns a full error message that includes the filter expression and the location of the error within it.
QString | styleSheet () const
| Returns the base style sheet, excluding any state-driven overrides.
QString | deprecatedToken ()
| Returns the deprecated token string when the state is Deprecated.
void | setCompleter (QCompleter *c)
| Installs a QCompleter for token-based autocompletion.
QCompleter * | completer () const
| Returns the currently installed completer.
void | allowCompletion (bool enabled)
| Enables or disables autocompletion without removing the completer.

## Protected Member Functions
void | keyPressEvent (QKeyEvent *event) override
| Handles key press events, forwarding them to the auto-completion logic.
void | focusInEvent (QFocusEvent *event) override
| Handles focus in events, forwarding them to the auto-completion logic.
Protected Member Functions inherited from SyntaxLineEdit
void | setCompletionTokenChars (const QString &token_chars)
| Sets the characters that may appear in a completion token (e.g. letters, digits, underscores, dots). Must be called by subclasses before completion is used.
bool | isComplexFilter (const QString &filter)
| Returns `true` if `filter` contains operators or structure that make it too complex for token-level autocompletion.
QPoint | getTokenUnderCursor ()
| Returns the start position and length of the token under the cursor.
QStringList | splitLineUnderCursor ()
| Splits the line at the cursor into the preamble and the current token.
virtual bool | event (QEvent *event) override
| Intercepts Tab and other keys to trigger or dismiss the completer.
void | completionKeyPressEvent (QKeyEvent *event)
| Handles key press events while the completer popup is visible, forwarding navigation keys to the popup and committing on Enter/Tab.
void | completionFocusInEvent (QFocusEvent *event)
| Triggers a completion refresh when the widget gains focus.
virtual void | focusOutEvent (QFocusEvent *event) override
| Hides the completer popup when the widget loses focus.
virtual void | paintEvent (QPaintEvent *event) override
| Paints the widget, overlaying a state-appropriate background colour.

## Additional Inherited Members
Public Types inherited from SyntaxLineEdit
enum | SyntaxState { Empty , Busy , Invalid , Deprecated , Valid }
| Visual and semantic state of the text currently in the editor. More...
Static Public Member Functions inherited from SyntaxLineEdit
static QString | createSyntaxErrorMessageFull (const QString &filter, const QString &err_msg, qsizetype loc_start, size_t loc_length)
| Builds a full syntax error message string combining the filter expression with a location-annotated error description.
Protected Attributes inherited from SyntaxLineEdit
QCompleter * | completer_
QStringListModel * | completion_model_
Properties inherited from SyntaxLineEdit
SyntaxState | syntaxState

## Detailed Description

A line edit widget that provides syntax validation and auto-completion for dissector names.

## Constructor & Destructor Documentation

## ◆ DissectorSyntaxLineEdit()

DissectorSyntaxLineEdit::DissectorSyntaxLineEdit | ( | QWidget * | parent = 0 | ) |
| explicit

Constructs a new DissectorSyntaxLineEdit widget.

Parameters

  parent | The parent widget, defaults to 0.

## Member Function Documentation

## ◆ checkDissectorName

void DissectorSyntaxLineEdit::checkDissectorName | ( | const QString & | dissector | ) |
| slot

Validates the syntax of the provided dissector name string.

Parameters

  dissector | The dissector name string to check.

## ◆ focusInEvent()

void DissectorSyntaxLineEdit::focusInEvent | ( | QFocusEvent * | event | ) |
| inline override protected

Handles focus in events, forwarding them to the auto-completion logic.

Parameters

  event | The focus event.

## ◆ keyPressEvent()

void DissectorSyntaxLineEdit::keyPressEvent | ( | QKeyEvent * | event | ) |
| inline override protected

Handles key press events, forwarding them to the auto-completion logic.

Parameters

  event | The key press event.

The documentation for this class was generated from the following files:

- /builds/wireshark/wireshark/ui/qt/widgets/dissector_syntax_line_edit.h
- /builds/wireshark/wireshark/ui/qt/widgets/dissector_syntax_line_edit.cpp