Registration::Query Class Reference

A wrapping class for the XEP-0077 <query> element. More...

#include <registration.h>

Inherits StanzaExtension.

Inheritance diagram for Registration::Query:

[legend]List of all members.

Public Member Functions
	Query (DataForm *form)
	Query (bool del=false)
	Query (int fields, const RegistrationFields &values)
	Query (const Tag *tag)
virtual	~Query ()
const DataForm *	form () const
const std::string &	instructions () const
int	fields () const
virtual const std::string &	filterString () const
virtual StanzaExtension *	newInstance (const Tag *tag) const
virtual Tag *	tag () const

---

Detailed Description

A wrapping class for the XEP-0077 <query> element.

Author:

Jakob Schroeter <js@camaya.net>

Since:

1.0

Definition at line 207 of file registration.h.

---

Constructor & Destructor Documentation

Query (  DataForm *  form  )

Creates a new object that can be used to carry out a search. Parameters: form  A DataForm containing the search terms. Definition at line 26 of file registration.cpp.

Query (  bool  del = false  )

Creates a new object that can be used to carry out a search. Parameters: del  Whether or not to remove the account. Definition at line 32 of file registration.cpp.

Query (  int  fields, const RegistrationFields &  values )

Creates a new object that can be used to carry out a search. Parameters: fields  Bit-wise ORed FieldEnum values describing the valid (i.e., set) fields in the values parameter. values  Contains the phrases to search for. Definition at line 38 of file registration.cpp.

Query (  const Tag *  tag  )

Creates a new object that can be used to request search fields. Optionally, it can parse the given Tag. Parameters: tag  The Tag to parse. Definition at line 44 of file registration.cpp.

~Query (   )  [virtual]

Virtual Destructor. Definition at line 149 of file registration.cpp.

---

Member Function Documentation

int fields (   )  const [inline]

Returns the search fields, if set. Returns: The search fields. Definition at line 258 of file registration.h.

const std::string & filterString (   )  const [virtual]

Returns an XPath expression that describes a path to child elements of a stanza that an extension handles. Returns: The extension's filter string. Implements StanzaExtension. Definition at line 155 of file registration.cpp.

const DataForm* form (   )  const [inline]

Returns the contained search form, if any. Returns: The search form. May be 0. Definition at line 246 of file registration.h.

const std::string& instructions (   )  const [inline]

Returns the search instructions, if given Returns: The search instructions. Definition at line 252 of file registration.h.

virtual StanzaExtension* newInstance (  const Tag *  tag  )  const [inline, virtual]

Returns a new Instance of the derived type. Usually, for a derived class FooExtension, the implementation of this function looks like: StanzaExtension* FooExtension::newInstance( const Tag* tag ) const { return new FooExtension( tag ); } Returns: The derived extension's new instance. Implements StanzaExtension. Definition at line 279 of file registration.h.

Tag * tag (   )  const [virtual]

Returns a Tag representation of the extension. Returns: A Tag representation of the extension. Implements StanzaExtension. Definition at line 161 of file registration.cpp.

---

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

• registration.h
• registration.cpp

---