diff --git a/docs/xml/lcl/lazdeviceapis.xml b/docs/xml/lcl/lazdeviceapis.xml index 8e23cdb643..ec22df8d05 100644 --- a/docs/xml/lcl/lazdeviceapis.xml +++ b/docs/xml/lcl/lazdeviceapis.xml @@ -165,8 +165,12 @@ because there is no signal here. - - +Sends a message to the target specified on it +

The message to be sent should be created with the method CreateMessage +from this same class and later released with FreeMessage. The same message can be +sent multiple times, but ideally it should not be edited after sending the first +time to avoid confusion when obtaining the message object back in the status +callback.

@@ -181,7 +185,7 @@ because there is no signal here. - +Creates a new message which can be sent with SendMessage @@ -197,7 +201,7 @@ because there is no signal here. - +Removes a message created with CreateMessage @@ -222,7 +226,7 @@ because there is no signal here. - +Represents the hardware GPS device @@ -233,7 +237,7 @@ because there is no signal here. - +Indicates if position info was read in the life of this program @@ -242,7 +246,7 @@ because there is no signal here. - +The horizontal accuracy of the position in meters @@ -251,7 +255,7 @@ because there is no signal here. - +Altitude in meters in relation to the sea level using the World Geodetic System 1984 (WGS84) datum @@ -260,16 +264,7 @@ because there is no signal here. - - - - - - - - - - +The vertical accuracy of the position in meters, or zero if not available @@ -278,7 +273,7 @@ because there is no signal here. - +Latitude in degrees using the World Geodetic System 1984 (WGS84) datum @@ -287,7 +282,16 @@ because there is no signal here. - +Longitude in degrees using the World Geodetic System 1984 (WGS84) datum + + + + + + + + +In meters / second @@ -296,7 +300,7 @@ because there is no signal here. - +The time when the latest location was established @@ -321,7 +325,7 @@ because there is no signal here. - +Called asynchronously when the position is read diff --git a/lcl/lazdeviceapis.pas b/lcl/lazdeviceapis.pas index e9567365ba..0c2e52aeee 100644 --- a/lcl/lazdeviceapis.pas +++ b/lcl/lazdeviceapis.pas @@ -70,11 +70,13 @@ type public constructor Create; virtual; destructor Destroy; override; - procedure SendMessage(AMsg: TLazDeviceMessage); // Attempt to send the specified message. + // Attempt to send the specified message. + procedure SendMessage(AMsg: TLazDeviceMessage); function CreateMessage: TLazDeviceMessage; procedure FreeMessage(AMessage: TLazDeviceMessage); - // Called asynchronously when there is a message sending status - property OnMessagingStatus: TOnMessagingStatus read FOnMessagingStatus write FOnMessagingStatus; + // Called asynchronously when there is a message status + property OnMessagingStatus: TOnMessagingStatus + read FOnMessagingStatus write FOnMessagingStatus; end; // TLazPositionInfo @@ -86,12 +88,12 @@ type IsPositionDataAvailable: Boolean; // Indicates if position info was read in the life of this program // These fields hold the last position information read accuracy: Double; // The horizontal accuracy of the position in meters - altitude: Double; // Altitude in meters using the World Geodetic System 1984 (WGS84) datum. - altitudeAccuracy: Double; // The vertical accuracy of the position in meters, or null if not available. + altitude: Double; // Altitude in meters in relation to the sea level using the World Geodetic System 1984 (WGS84) datum. + altitudeAccuracy: Double; // The vertical accuracy of the position in meters, or zero if not available. latitude: Double; // Latitude in degrees using the World Geodetic System 1984 (WGS84) datum. longitude: Double; // Longitude in degrees using the World Geodetic System 1984 (WGS84) datum. speed: Double; // In meters / second - timeStamp: TDateTime; // The time when the location was established. + timeStamp: TDateTime; // The time when the latest location was established. procedure RequestPositionInfo(AMethod: TLazPositionMethod); // Called asynchronously when the position is read property OnPositionRetrieved: TNotifyEvent read FOnPositionRetrieved write FOnPositionRetrieved;