google_customsearch_api::Search::SearchSpelling Class Reference

#include <search.h>

Inheritance diagram for google_customsearch_api::Search::SearchSpelling:

Public Member Functions
	SearchSpelling (const Json::Value &storage)
	SearchSpelling (Json::Value *storage)
virtual	~SearchSpelling ()
const StringPiece	GetTypeName () const
bool	has_corrected_query () const
void	clear_corrected_query ()
const StringPiece	get_corrected_query () const
void	set_corrected_query (const StringPiece &value)
bool	has_html_corrected_query () const
void	clear_html_corrected_query ()
const StringPiece	get_html_corrected_query () const
void	set_html_corrected_query (const StringPiece &value)

Static Public Member Functions
static SearchSpelling *	New ()

Detailed Description

Spell correction information for a query.

Constructor & Destructor Documentation

SearchSpelling() [1/2]

google_customsearch_api::Search::SearchSpelling::SearchSpelling ( const Json::Value &  storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

SearchSpelling() [2/2]

google_customsearch_api::Search::SearchSpelling::SearchSpelling ( Json::Value *  storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~SearchSpelling()

google_customsearch_api::Search::SearchSpelling::~SearchSpelling ( )

virtual

Standard destructor.

Member Function Documentation

clear_corrected_query()

void google_customsearch_api::Search::SearchSpelling::clear_corrected_query ( )

inline

Clears the 'correctedQuery' attribute.

clear_html_corrected_query()

void google_customsearch_api::Search::SearchSpelling::clear_html_corrected_query ( )

inline

Clears the 'htmlCorrectedQuery' attribute.

get_corrected_query()

const StringPiece google_customsearch_api::Search::SearchSpelling::get_corrected_query ( ) const

inline

Get the value of the 'correctedQuery' attribute.

get_html_corrected_query()

const StringPiece google_customsearch_api::Search::SearchSpelling::get_html_corrected_query ( ) const

inline

Get the value of the 'htmlCorrectedQuery' attribute.

GetTypeName()

const StringPiece google_customsearch_api::Search::SearchSpelling::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_customsearch_api::SearchSpelling

has_corrected_query()

bool google_customsearch_api::Search::SearchSpelling::has_corrected_query ( ) const

inline

Determine if the 'correctedQuery' attribute was set.

Returns

true if the 'correctedQuery' attribute was set.

has_html_corrected_query()

bool google_customsearch_api::Search::SearchSpelling::has_html_corrected_query ( ) const

inline

Determine if the 'htmlCorrectedQuery' attribute was set.

Returns

true if the 'htmlCorrectedQuery' attribute was set.

New()

Search::SearchSpelling * google_customsearch_api::Search::SearchSpelling::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_corrected_query()

void google_customsearch_api::Search::SearchSpelling::set_corrected_query ( const StringPiece &  value )

inline

Change the 'correctedQuery' attribute.

The corrected query.

Parameters

[in]

value

The new value.

set_html_corrected_query()

void google_customsearch_api::Search::SearchSpelling::set_html_corrected_query ( const StringPiece &  value )

inline

Change the 'htmlCorrectedQuery' attribute.

The corrected query, formatted in HTML.

Parameters

[in]

value

The new value.

---

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

• google/customsearch_api/search.h
• google/customsearch_api/search.cc