All Classes Functions Variables Typedefs Friends Pages
Public Member Functions | List of all members
Glympse::IPlaceSearchEngine Struct Referenceabstract

Exposes place search functionality. More...

#include <IPlaceSearchEngine.h>

Inheritance diagram for Glympse::IPlaceSearchEngine:
Inheritance graph
[legend]

Public Member Functions

virtual GPlaceSearchRequest search (const GString &term, const GLatLng &location, const GCommonObj &context)=0
 Initiates search of POIs based on search term and location. More...
 
- Public Member Functions inherited from Glympse::IEventSink
virtual bool addListener (const GEventListener &eventListener)=0
 Registeres event listener on the sink. More...
 
virtual bool removeListener (const GEventListener &eventListener)=0
 Unsubscribes listener from events coming from this sink.
 
virtual GArray< GEventListener >
::ptr 
getListeners ()=0
 Provides access to the collection of current listeners. More...
 
virtual bool hasContext (int64 key)=0
 Checks, where user context identified by key is already associated with the object.
 
virtual void associateContext (int64 key, const GCommonObj &value)=0
 Associates specific context (user data) with the sink. More...
 
virtual GCommonObj getContext (int64 key)=0
 Returns context associated with the sink, or NULL, if it is not found.
 
virtual void clearContext (int64 key)=0
 Clears context identified by key argument.
 
virtual GEnumeration< GLong >::ptr getContextKeys ()=0
 Gets enumeration of all context keys associated with the sink.
 
virtual void deriveContext (const GEventSink &sink)=0
 Derives context from another sink object.
 
- Public Member Functions inherited from Glympse::IEventListener
virtual void eventsOccurred (const GGlympse &glympse, int32 listener, int32 events, const GCommonObj &obj)=0
 This method is invoked each time, when sink object notifies subscriber on an event. More...
 
- Public Member Functions inherited from Glympse::ICommon
virtual int32 retain ()=0
 Add a reference to our object in a COM-like way.
 
virtual int32 release ()=0
 Release a reference to our object in a COM-like way.
 
virtual int32 hold ()=0
 Add a reference to our object in a COM-like way.
 
virtual int32 unhold ()=0
 Release a reference to our object in a COM-like way.
 
virtual int32 hashCode ()=0
 Returns an integer hash code for this object.
 
virtual bool equals (const GCommonObj &o)=0
 Compares this instance with the specified object and indicates if they are equal. More...
 
virtual GString toString ()=0
 Returns a string containing a concise, human-readable description of this object. More...
 
virtual void attachObject (const GCommon &obj)=0
 Asociates arbitrary object with the instance.
 
virtual GCommon extractObject ()=0
 Extracts associated object or NULL if no association is established.
 

Additional Inherited Members

- Protected Member Functions inherited from Glympse::ICommon
virtual ~ICommon ()
 Destructor is protected to deny explicit object deallocation. More...
 

Detailed Description

Exposes place search functionality.

See Also
GlympseEvents::LISTENER_PLACE_SEARCH for the list of events fired by this component.
Note
This feature must be enabled on API key basis and is disabled by default.

Member Function Documentation

virtual GPlaceSearchRequest Glympse::IPlaceSearchEngine::search ( const GString term,
const GLatLng location,
const GCommonObj context 
)
pure virtual

Initiates search of POIs based on search term and location.

Multiple simultaneous searches are not currently supported. Subsequent request automatically cancels previously scheduled one whithout sending any confirmation events.

GlympseEvents::PLACE_SEARCH_COMPLETED is fired upon success even if no POIs are found. GlympseEvents::PLACE_SEARCH_FAILED indicates that search request has failed without providing a reason.

Parameters
termSearch query provided by the user.
locationCenter point of the area where search is performed.
contextArbitrary context provided by host application.
Returns
Instance of GPlaceSearchRequest object encapsulating request details.

The documentation for this struct was generated from the following file: