• Skip to content
  • Skip to link menu
KDE 4.0 API Reference
  • KDE API Reference
  • kdeedu
  • Sitemap
  • Contact Us
 

kalzium

Search Class Reference

#include <search.h>

Inheritance diagram for Search:

Inheritance graph
[legend]

List of all members.


Detailed Description

Represent a search.

Author:
Pino Toscano

Definition at line 34 of file search.h.


Public Types

enum  SearchKind { SearchByName = 0x01, SearchBySymbol = 0x02, SearchAll = 0xFF }

Public Slots

void doSearch (const QString &text, SearchKind kind)
void resetSearch ()

Signals

void searchChanged ()
void searchReset ()

Public Member Functions

 Search ()
QString searchText () const
SearchKind searchKind () const
bool isActive () const
const QList< Element * > & foundElements () const
bool matches (Element *el) const

Member Enumeration Documentation

enum Search::SearchKind

The kind of search we can perform.

Enumerator:
SearchByName 
SearchBySymbol 
SearchAll 

Definition at line 42 of file search.h.


Constructor & Destructor Documentation

Search::Search (  ) 

Construct a new empty search.

Definition at line 25 of file search.cpp.


Member Function Documentation

QString Search::searchText (  )  const

Returns:
the search text

Definition at line 30 of file search.cpp.

Search::SearchKind Search::searchKind (  )  const

Returns:
the kind of search

Definition at line 35 of file search.cpp.

bool Search::isActive (  )  const

is the current Search active?

Returns:
whether this search is active

Definition at line 40 of file search.cpp.

const QList< Element * > & Search::foundElements (  )  const

Returns:
the found elements

Definition at line 45 of file search.cpp.

bool Search::matches ( Element *  el  )  const

Returns:
whether the element el matches the search

Definition at line 50 of file search.cpp.

void Search::doSearch ( const QString &  text,
SearchKind  kind 
) [slot]

Search the text by looking at the element using the specified kind.

Definition at line 55 of file search.cpp.

void Search::resetSearch (  )  [slot]

Reset the current search (and put it not active).

Definition at line 76 of file search.cpp.

void Search::searchChanged (  )  [signal]

The current search has changed (ie the found elements have changed).

void Search::searchReset (  )  [signal]

The current search has been reset.


The documentation for this class was generated from the following files:
  • search.h
  • search.cpp

kalzium

Skip menu "kalzium"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdeedu

Skip menu "kdeedu"
  • kalzium
  • kanagram
  • kig
  • klettres
  • kstars
  • libkdeedu
  •   keduvocdocument
  •   docs
  •   src
  • parley
Generated for kdeedu by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal