From 0ba12a0f2977d6093c249d51a8ca3b764c83dac5 Mon Sep 17 00:00:00 2001
From: mattias <nc-gaertnma@netcologne.de>
Date: Sun, 20 Jul 2003 06:39:03 +0000
Subject: [PATCH] added comments

git-svn-id: trunk@4413 -
---
 lcl/include/interfacebase.inc    | 14 +++++++++++---
 lcl/interfaces/gtk/gtkwinapi.inc |  9 +++++++--
 2 files changed, 18 insertions(+), 5 deletions(-)

diff --git a/lcl/include/interfacebase.inc b/lcl/include/interfacebase.inc
index cea352855d..8010834e04 100644
--- a/lcl/include/interfacebase.inc
+++ b/lcl/include/interfacebase.inc
@@ -1060,15 +1060,19 @@ Begin
 end;
 
 function TInterfaceBase.GetWindowRect(Handle : hwnd; var Rect : TRect): Integer;
+{ After the call, ARect will be the control area in screen coordinates.
+  That means, Left and Top will be the screen coordinate of the TopLeft pixel
+  of the Handle object and Right and Bottom will be the screen coordinate of
+  the BottomRight pixel. }
 begin
   Result := 0;
 end;
 
 function TInterfaceBase.GetWindowRelativePosition(Handle : hwnd;
   var Left, Top: integer): boolean;
-// return the position of the left, top coordinate relative to the clientorigin
-// of its parent. This is normally the Left, Top of a TWinControl. But not
-// during moving/sizing.
+{ returns the position of the left, top coordinate relative to the clientorigin
+  of its parent. This is normally the Left, Top of a TWinControl. But not
+  during moving/sizing. }
 var
   ChildRect: TRect;
   ParentLeftTop: TPoint;
@@ -1091,6 +1095,7 @@ end;
 
 Function TInterfaceBase.GetWindowSize(Handle : hwnd;
   var Width, Height: integer): boolean;
+// Returns the current Width and Height
 begin
   Result:=false;
 end;
@@ -1805,6 +1810,9 @@ end;
 { =============================================================================
 
   $Log$
+  Revision 1.98  2003/07/20 06:39:03  mattias
+  added comments
+
   Revision 1.97  2003/07/20 06:27:19  mattias
   fixed GetWindowRelativePosition
 
diff --git a/lcl/interfaces/gtk/gtkwinapi.inc b/lcl/interfaces/gtk/gtkwinapi.inc
index d7b5385f91..509f0fe111 100644
--- a/lcl/interfaces/gtk/gtkwinapi.inc
+++ b/lcl/interfaces/gtk/gtkwinapi.inc
@@ -246,7 +246,9 @@ end;
 {------------------------------------------------------------------------------
   Function: ClientToScreen
   Params:  Handle : HWND; var P : TPoint
-  Returns: Nothing
+  Returns: true on success
+  
+  Converts the client-area coordinates of P to screen coordinates.
  ------------------------------------------------------------------------------}
 Function TgtkObject.ClientToScreen(Handle : HWND; var P : TPoint) : Boolean;
 var
@@ -5020,7 +5022,7 @@ end;
   Params:  none
   Returns: Nothing
 
-  Returns the x-coordinates and y-coordinates of the window origin for the
+  Returns the x- and y-coordinates of the window origin for the
   specified device context.
  ------------------------------------------------------------------------------}
 function TgtkObject.GetWindowOrgEx(dc : hdc; P : PPoint): Integer;
@@ -8606,6 +8608,9 @@ end;
 { =============================================================================
 
   $Log$
+  Revision 1.263  2003/07/20 06:39:03  mattias
+  added comments
+
   Revision 1.262  2003/07/08 20:09:40  mattias
   updated build fpc rpm script