kspread

KSpread::FunctionCompletion Class Reference

Provides autocompletition facilities in formula editors. More...

#include <Editors.h>

Inheritance diagram for KSpread::FunctionCompletion:

List of all members.

Public Slots

void doneCompletion ()

Signals

void selectedCompletion (const QString &item)

Public Member Functions

 FunctionCompletion (CellEditor *editor)
 ~FunctionCompletion ()
bool eventFilter (QObject *o, QEvent *e)
void showCompletion (const QStringList &choices)

Detailed Description

Provides autocompletition facilities in formula editors.

When the user types in the first few characters of a function name in a CellEditor which has a FunctionCompletion object installed on it, the FunctionCompletion object creates and displays a list of possible names which the user can select from. If the user selects a function name from the list, the FunctionCompletion::selectedCompletion() signal is emitted

Definition at line 135 of file Editors.h.


Constructor & Destructor Documentation

FunctionCompletion::FunctionCompletion ( CellEditor editor  ) 

Definition at line 326 of file Editors.cpp.

FunctionCompletion::~FunctionCompletion (  ) 

Definition at line 365 of file Editors.cpp.


Member Function Documentation

void FunctionCompletion::doneCompletion (  )  [slot]

Hides the autocompletion list box if it is visible and emits the selectedCompletion signal.

Definition at line 453 of file Editors.cpp.

bool FunctionCompletion::eventFilter ( QObject o,
QEvent e 
)

Handles various keyboard and mouse actions which may occur on the autocompletion popup list.

Definition at line 413 of file Editors.cpp.

void KSpread::FunctionCompletion::selectedCompletion ( const QString item  )  [signal]

Emitted, if the user selects a function name from the list.

void FunctionCompletion::showCompletion ( const QStringList choices  ) 

Populates the autocompletion list box with the specified choices and shows it so that the user can view and select a function name.

Parameters:
choices A list of possible function names which match the characters that the user has already entered.

Definition at line 461 of file Editors.cpp.


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