/**
* This is a constructor. It initializes a new instance of the tile key with
* the zoom level and the x and y coordinates of the tile at that zoom level.
- *
+ *
* @param aLevel A value indicating the zoom level.
- *
+ *
* @param aX A value indicating the x coordinate in the map tile grid.
- *
+ *
* @param aY A value indicating the y coordinate in the map tile grid.
*
* @param aMapLanguage A value indicating the map language.
*
* @param aMapLanguage A value indicating the map type.
- */
+ */
TileKey(int aLevel,
int aX,
int aY,
- String sMapLanguage = String("eng"),
+ String sMapLanguage = String("en-US"),
GeoTiledMap::MapType aMapType = GeoTiledMap::MT_Normal_Day)
{
m_aLevel = aLevel;
m_aMapType = aMapType;
}
- /**
+ /**
* This method is a copy constructor.
- *
+ *
* @param rRhs A constant reference to an object whose contents are to be
* copied into the present instance.
*/
/**
* This method retrieves a tile hash value based on the tile key properties.
- *
+ *
* @return An integer value representing the tile hash.
*/
int GetHash() const
return hashValue;
}
- /**
+ /**
* This is an equality operator.
- *
+ *
* @param rRhs A constant reference to an object that is to be compared to
* the present instance.
- *
+ *
* @return <code>true</code> if the given instance and the right-hand object
* are identical, otherwise <code>false</code>.
*/
m_aMapType == rRhs.m_aMapType;
}
- /**
+ /**
* This is an assignment operator.
- *
+ *
* @param rRhs A constant reference to an object whose contents are to be
* copied into the present instance.
- *
+ *
* @return A reference to the given instance of the class after the assignment.
*/
TileKey& operator = (const TileKey& rRhs)
/**
* This member variable holds a value indicating the tile zoom level.
- */
+ */
int m_aLevel;
/**
* This member variable holds a value indicating the x coordinate of the tile.
- */
+ */
int m_aX;
/**
* This member variable holds a value indicating the y coordinate of the tile.
- */
+ */
int m_aY;
/**
*/
void SetUpdateMapSignal(UpdateMapSignalFunctor slot);
- /**
- * This method sets the map type.
- *
- * @param aMapType A value indicating the new map type.
- */
+ /**
+ * This method sets the map type.
+ *
+ * @param aMapType A value indicating the new map type.
+ */
void SetMapType(MapType aMapType);
- /**
- * This method retrieves the map type.
- *
- * @return A value indicating the current map type.
- */
+ /**
+ * This method retrieves the map type.
+ *
+ * @return A value indicating the current map type.
+ */
MapType GetMapType() const;
+#ifdef TIZEN_MIGRATION
+ /**
+ * This method retrieves the current language of the map.
+ *
+ * A language is specified as an ISO 3166 alpha-2 two letter country-code
+ * followed by ISO 639-1 for the two-letter language code.
+ * Each language tag is composed of one or more "subtags" separated by hyphens (-).
+ * Each subtag is composed of basic Latin letters or digits only.
+ * For example, "ko-KR" for Korean, "en-US" for American English.
+ */
+#else
/*
* Available language options are:
* L"ara", L"chi", L"cht", L"dut", L"eng", L"ger", L"gle", L"fre", L"ita", L"spa", L"rus", L"pol", L"gre", L"wel"
* "ita" (Italian), "spa" (Spanish), "rus" (Russian), "pol" (Polish),
* "gre" (Greek), "wel" (Welsh)
*/
+#endif
void SetMapLanguage(const String& aMapLanguage);
+#ifdef TIZEN_MIGRATION
+ /**
+ * This method retrieves the current language of the map.
+ *
+ * A language is specified as an ISO 3166 alpha-2 two letter country-code
+ * followed by ISO 639-1 for the two-letter language code.
+ * Each language tag is composed of one or more "subtags" separated by hyphens (-).
+ * Each subtag is composed of basic Latin letters or digits only.
+ * For example, "ko-KR" for Korean, "en-US" for American English.
+ */
+#else
/**
* This method retrieves the current language of the map.
*
* "gle" (Irish), "fre" (French), "ita" (Italian), "spa" (Spanish),
* "rus" (Russian), "pol" (Polish), "gre" (Greek), "wel" (Welsh)
*/
+#endif
const String& GetMapLanguage() const;
/**
* start and end points, waypoints (the locations through which the route must
* pass), areas to include and to avoid, mode of travel, route features with
* weighting, required optimization, etc.
- *
+ *
* \ingroup routes
*/
class EXPORT_API GeoRouteQuery : public BaseQuery
public:
/**
- * This enumeration defines identifiers for the supported modes of travel.
+ * This enumeration defines identifiers for the supported modes of travel.
*/
enum TravelMode {
TM_CarTravel = 0x0001, ///< Indicates that the route is to be
/**
* This enumeration defines identifiers for the supported route feature
* types, feature types that can be favored or excluded by the route
- * calculation.
+ * calculation.
*/
enum FeatureType {
FT_NoFeature = 0x00000000, ///< Indicates no route features (are selected).
FT_BoatFerryFeature = 0x00000004, ///< Indicates a boat ferry.
FT_RailFerryFeature = 0x00000008, ///< Indicates rail (train) ferry.
FT_PublicTransitFeature = 0x00000010, ///< Indicates public transport.
- FT_TunnelFeature = 0x00000020, ///< Indicates tunnel.
+ FT_TunnelFeature = 0x00000020, ///< Indicates tunnel.
FT_DirtRoadFeature = 0x00000040, ///< Indicates dirt road.
- FT_ParksFeature = 0x00000080, ///< Indicates park.
- FT_HOVLane = 0x00000100, ///< Indicates a high-occupancy vehicle lane.
+ FT_ParksFeature = 0x00000080, ///< Indicates park.
+ FT_HOVLane = 0x00000100, ///< Indicates a high-occupancy vehicle lane.
FT_Stairs = 0x00000200 ///< Indicates stairs.
- };
+ };
- /**
- * This enumeration defines identifiers for the supported route feature weighting.
+ /**
+ * This enumeration defines identifiers for the supported route feature weighting.
*/
enum FeatureWeight {
FW_NormalFeatureWeight = 0x00000000, ///< Indicates normal weighting.
FW_PreferFeatureWeight = 0x00000001, ///< Indicates that a feature is preferred.
- FW_AvoidFeatureWeight = 0x00000002, ///< Indicates that a feature is to be avoided.
+ FW_AvoidFeatureWeight = 0x00000002, ///< Indicates that a feature is to be avoided.
FW_SoftExcludeFeatureWeight = 0x00000004, ///< Indicates that soft-exclude applies to the feature.
- FW_StrictExcludeFeatureWeight = 0x00000008 ///< Indicates that the feature is to be strictly excluded.
+ FW_StrictExcludeFeatureWeight = 0x00000008 ///< Indicates that the feature is to be strictly excluded.
};
/**
*/
typedef std::map< GeoRouteQuery::FeatureType, GeoRouteQuery::FeatureWeight > FeaturesMap;
- /**
- * This enumeration defines identifiers for the supported route optimizations.
+ /**
+ * This enumeration defines identifiers for the supported route optimizations.
*/
enum RouteOptimization {
RO_ShortestRoute = 0x0001, ///< Indicates the shortest route.
RO_FastestRoute = 0x0002, ///< Indicates the fastest route.
};
- /**
- * This enumeration defines identifiers for route segment detail specifiers.
+ /**
+ * This enumeration defines identifiers for route segment detail specifiers.
*/
enum SegmentDetail {
SD_NoSegmentData = 0x0000, ///< Indicates that no route segment data are to be included.
SD_BasicSegmentData = 0x0001 ///< Indicates that basic route segment data are to be included.
};
- /**
- * This enumeration defines identifiers for route maneuver specifiers.
+ /**
+ * This enumeration defines identifiers for route maneuver specifiers.
*/
enum ManeuverDetail {
MD_NoManeuvers = 0x0000, ///< Indicates that manuevers are to be included int he route.
};
#ifdef TIZEN_CUSTOMIZATION
- /**
+ /**
* This enumeration defines identifiers for route MetricSystem specifiers.
*/
enum MetricSystem {
/**
* This method is a constructor that initializes a new instance of the
* class, using the list of waypoints supplied by the caller.
- *
+ *
* @param rWaypoints A constant reference to a vector of instances of
* <code>GeoCoordinates</code> that define the route waypoints.
*/
* This method is a constructor that initializes a new instance of the
* class, using the objects representing the route origin and destination
* supplied by the caller.
- *
+ *
* @param rOrigin A constant reference to an object that defines the point
* of origin for the route.
- *
- * @param rDestination A constant reference to an object that defines the
+ *
+ * @param rDestination A constant reference to an object that defines the
* destination for the route.
*/
GeoRouteQuery(const GeoCoordinates &rOrigin, const GeoCoordinates &rDestination);
* This method is a copy constructor that initializes a new instance of the
* class by copying the values of the properties of the object supplied by
* the caller.
- *
+ *
* @param rRhs A constant reference to an object whose property values are
* to be used to initialize a new instance of the class.
*/
GeoRouteQuery(const GeoRouteQuery &rRhs);
- /**
+ /**
* This method is the destructor for objects of this class.
*/
~GeoRouteQuery();
- /**
+ /**
* This is the assignment operator.
- *
+ *
* @param rRhs A constant reference to an object whose property values are
* to be copied to the given instance.
*/
/**
* This method sets route waypoints, using the list of objects supplied by
* the caller.
- *
+ *
* @param rWaypoints A constant reference to a vector of instances of
* <code>GeoCoordinates</code> that define the route waypoints.
*/
/**
* This method retrieves the route waypoints.
- *
+ *
* @return A vector of instances of <code>GeoCoordinates</code> that define
* the route waypoints.
*/
GeoCoordinateList GetWaypoints() const;
- /**
+ /**
* This method sets areas through which the route must not pass, using a
* list of bounding box objects supplied by the caller.
- *
+ *
* @param rAreas A constant reference to a list of bounding box objects that
* define the areas the route must avoid.
*/
void SetExcludeAreas(const GeoBoundingBoxList &rAreas);
- /**
+ /**
* This method retrieves a list of bounding boxes that defines areas through
- * which the route must not pass.
- *
+ * which the route must not pass.
+ *
* @return A list of bounding box objects that define the areas the route
* must avoid.
*/
// defaults to TravelByCar
/**
* This method sets the travel mode to be used in the route query.
- *
+ *
* @param aTravelModes A value indicating the travel mode to use in the
* query.
*/
/**
* This method retrieves the travel mode used in the route query.
- *
+ *
* @return A value indicating the travel mode used in the
* query.
*/
/**
* This method associates weighting with a feature to be used in the route
- * query.
- *
+ * query.
+ *
* @param aFeatureType A value indicating the feature type to which the
* weighting is to apply.
- *
+ *
* @param aFeatureWeight A value indicating the weighting to apply.
*/
void SetFeatureWeight(FeatureType aFeatureType, FeatureWeight aFeatureWeight);
/**
* This method retrieves the weighting for the feature type specified by the
- * caller.
- *
- * @param aFeatureType A value indicating the feature type for which to
+ * caller.
+ *
+ * @param aFeatureType A value indicating the feature type for which to
* retrieve weighting.
- *
+ *
* @return A value indicating the weighting associated with the named route
* feature.
*/
/**
* This method retrieves a map of route feature types specified for the
* given query.
- *
+ *
* @return An object containing a map of route feature types specified for
* the given query.
*/
// defaults to OptimizeFastes)
/**
* This method sets the route optimization option for the given query.
- *
+ *
* @param aOptimization A value indicating the route optimization option to
* set for the given query.
*/
/**
* This method retrieves the route optimization selector set for the given
* query.
- *
+ *
* @return A value indicating the route optimization selector set for the
* given query.
*/
// defaults to BasicSegmentData
/**
* This method sets the segment detail selector for the given query.
- *
+ *
* @param aSegmentDetail A value indicating the segment detail selector for
* the given query.
*/
/**
* This method retrieves the segment detail selector for the given query.
- *
+ *
* @return A value indicating the segment detail selector set for the given
* query.
*/
// defaults to BasicManeuvers
/**
* This method sets the maneuver detail selector for the given
- * query.
- *
+ * query.
+ *
* @param aManeuverDetail A value indicating the maneuver detail selector for
* the given query.
*/
/**
* This method retrieves the maneuver detail selector set for the given
- * query.
- *
+ * query.
+ *
* @return A value indicating the maneuver detail selector for
* the given query.
*/
#ifdef TIZEN_CUSTOMIZATION
/**
* This method sets the MetricSystem selector for the given
- * query.
+ * query.
*
* @param aMetricSystem A value indicating the MetricSystemselector for
* the given query.
* @return An value indicating the arrival time.
*/
time_t GetArrivalTime(void) const;
+
+ /**
+ * This method retrieves a BCP 47 identifier of the search language.
+ *
+ * @return A string containing a BCP 47 identifier of the language.
+ */
+ String GetLanguage() const;
+
+ /**
+ * This method sets the langauge, using a BCP 47 langauge code.
+ *
+ * @param sSearch A constant reference to a string containing a BCP 47
+ * identifier of the language.
+ */
+ void SetLanguage(const String& sLang);
#endif
/**
* This method attempts to establish a connection with the server and then,
* if the connection has been established, it builds and submits a query.
- *
+ *
* @rListener rListener A reference to an object that is to be notified when
* the reply to the query has arrived from the server.
- *
+ *
* @param pUserData A pointer to user data to be passed back within the
* corresponding reply object.
*
projects / platform / core / location / maps-plugin-here.git / commitdiff