InputData Class Reference

#include <catalog.h>


Detailed Description

InputData shows one segment (between tabs) of a user's query A user's query is typically represented by List<InputData> and each element of the list represents a segment of the query.

E.g. query = "google <tab> this is my search" will have 2 InputData segments in the list. One for "google" and one for "this is my search"

Definition at line 146 of file catalog.h.


Public Member Functions

QSet< uint > getLabels ()
 Get the labels applied to this query segment.
void setLabel (uint l)
 Apply a label to this query segment.
bool hasLabel (uint l)
 Check if it has the given label applied to it.
void setID (uint i)
 Set the id of this query.
uint getID ()
 Returns the current owner id of the query.
QString getText ()
 Get the text of the query segment.
void setText (QString t)
 Set the text of the query segment.
CatItemgetTopResult ()
 Get a pointer to the best catalog match for this segment of the query.
void setTopResult (CatItem sr)
 Change the best catalog match for this segment.
 InputData ()
 InputData (QString str)

Constructor & Destructor Documentation

InputData::InputData (  )  [inline]

Definition at line 190 of file catalog.h.

InputData::InputData ( QString  str  )  [inline]

Definition at line 191 of file catalog.h.


Member Function Documentation

QSet<uint> InputData::getLabels (  )  [inline]

Get the labels applied to this query segment.

Definition at line 159 of file catalog.h.

void InputData::setLabel ( uint  l  )  [inline]

Apply a label to this query segment.

Definition at line 161 of file catalog.h.

bool InputData::hasLabel ( uint  l  )  [inline]

Check if it has the given label applied to it.

Definition at line 163 of file catalog.h.

void InputData::setID ( uint  i  )  [inline]

Set the id of this query.

This can be used to override the owner of the selected catalog item, so that no matter what item is chosen from the catalog, the given plugin will be the one to execute it.

Parameters:
i The plugin id of the plugin to execute the query's best match from the catalog

Definition at line 173 of file catalog.h.

uint InputData::getID (  )  [inline]

Returns the current owner id of the query.

Definition at line 176 of file catalog.h.

QString InputData::getText (  )  [inline]

Get the text of the query segment.

Definition at line 179 of file catalog.h.

void InputData::setText ( QString  t  )  [inline]

Set the text of the query segment.

Definition at line 182 of file catalog.h.

CatItem& InputData::getTopResult (  )  [inline]

Get a pointer to the best catalog match for this segment of the query.

Definition at line 185 of file catalog.h.

void InputData::setTopResult ( CatItem  sr  )  [inline]

Change the best catalog match for this segment.

Definition at line 188 of file catalog.h.


The documentation for this class was generated from the following file:
Generated on Sat Jun 14 15:07:34 2008 for LaunchyPluginAPI by  doxygen 1.5.4