From 133f12ff980e3ee66943e102dd1b928a9a95b51f Mon Sep 17 00:00:00 2001 From: dodi Date: Tue, 20 Sep 2011 04:27:28 +0000 Subject: [PATCH] Docs: revised image lists. git-svn-id: trunk@32434 - --- docs/xml/lcl/controls.xml | 727 +++++++++++------------------ docs/xml/lcl/imglist.xml | 957 ++++++++++++++------------------------ 2 files changed, 609 insertions(+), 1075 deletions(-) diff --git a/docs/xml/lcl/controls.xml b/docs/xml/lcl/controls.xml index d31045e454..0f5e75238c 100644 --- a/docs/xml/lcl/controls.xml +++ b/docs/xml/lcl/controls.xml @@ -190,15 +190,13 @@ 
Details held include:
           the Message associated with the wheel;
           the shift state (ie whether Shift, Alt, Control etc keys have been pressed);
-          wheel data which can either be 
-	  a position (X, Y coordinates) or 
-	  a position plus an integer result.
+ mouse position and the message Result. - The exact Message ID. + The exact Message ID (WM_MOUSEWHEEL?). @@ -214,12 +212,26 @@ - - Mouse[?] position. - - - How many notches the wheel has turned. + How many notches the wheel has been turned; negative for turned backwards. + + + + + Mouse position. + + + Mouse X position. + + + + + Mouse Y position. + + + + + Zero indicates that the message was handled. @@ -232,25 +244,21 @@ - - - - @@ -258,39 +266,35 @@ - - - - - + [?] + + + + - - + - - - - - - + + + + + - - - - - - + + + + + - - - - - - + + + + + @@ -312,19 +316,15 @@ [?] - - + - - - @@ -336,22 +336,17 @@ - - - VK_XXX constants for TLMKeyDown/Up, ASCII for TLMChar. - - @@ -441,39 +436,79 @@ Set of possible anchor positions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Array of names for the elements. + + The names include the "al;" prefix, e.g. alNone. + + + + + Names for the TAnchorKind elements. + + + The side of another control, to which this control's side is anchored. - Anchor to the top side. - Anchor to the bottom side. - Anchor to the center of the other control. - Anchor to the left side. + Anchor to the left side (=asrTop). - Anchor to the right side. - - - - - - [?] + Anchor to the right side (=asrBottom). @@ -481,67 +516,62 @@ A string type for the caption of a control: may be translated - - - - TCursor - integer type defining range of values for cursor - Defines special form behaviour. - An ordinary (overlapping) form. - The form is an MDI child. - The form is an MDI parent form, containing MDI child forms. - The form is in the foreground, on top of all other application forms. - A splash form [meaning what?]. The form stays system-wide on top[?]. + + + Set of form styles, which make a form stay on top. + + + + + + Set of form styles, which make a form stay on top [not system-wide?]. + + Style of a form's border. - No border at all. - Single line border, the form cannot be resized. - The form can be resized (standard). - [legacy?] The form is a dialog, cannot be resized. - Single line border, small caption, not resizeable. - Small caption, form can be resized. @@ -562,11 +592,9 @@ - This control is notified when user presses Return. - This control is notified when user presses Escape. @@ -579,18 +607,14 @@ Enumeration of recognized mouse buttons.

These are logical buttons, left and right physical buttons can be swapped for left handed users.

-

[Nowadays mice with more buttons are available - how are these handled?]

 - Left button (can be physical right button for left handed). - Right button (can be physical left button for left handed). - Middle button. @@ -600,175 +624,155 @@ Second extra button. - - - Set of form styles, which make a form stay on top. - - + + + + TCursor - integer type defining range of values for cursor shapes. + +

Allowed values are:

+
+Standard cursors
+  crDefault     = TCursor(0);   //current cursor unchanged
+  crNone        = TCursor(-1);  //hide cursor
+  crArrow       = TCursor(-2);  //normal cursor
+  crCross       = TCursor(-3);  //graphics cursor, for pixel or rectangle selection
+  crIBeam       = TCursor(-4);  //text cursor, for setting insertion point
+Sizing cursors
+  crSize        = TCursor(-22);
+  crSizeAll     = TCursor(-22);
+  crSizeNESW    = TCursor(-6); // diagonal north east - south west
+  crSizeNS      = TCursor(-7);
+  crSizeNWSE    = TCursor(-8);
+  crSizeWE      = TCursor(-9);
+  crSizeNW      = TCursor(-23);
+  crSizeN       = TCursor(-24);
+  crSizeNE      = TCursor(-25);
+  crSizeW       = TCursor(-26);
+  crSizeE       = TCursor(-27);
+  crSizeSW      = TCursor(-28);
+  crSizeS       = TCursor(-29);
+  crSizeSE      = TCursor(-30);
+DragDrop cursors
+  crDrag        = TCursor(-12); //dragging, drop allowed
+  crNoDrop      = TCursor(-13); //dragging, drop disallowed/rejected
+  crMultiDrag   = TCursor(-16); //dragging multiple items
+  crNo          = TCursor(-18);
+Splitter cursors
+  crHSplit      = TCursor(-14);
+  crVSplit      = TCursor(-15);
+More cursors
+  crUpArrow     = TCursor(-10);
+  crHourGlass   = TCursor(-11); //busy
+  crSQLWait     = TCursor(-17);
+  crAppStart    = TCursor(-19);
+  crHelp        = TCursor(-20);
+  crHandPoint   = TCursor(-21);
+
+ - - - Set of form styles, which make a form stay on top system-wide[?]. - - - Highest defined cursor constant (0). - Default (parent) cursor constant (0) - Invisible cursor constant: no cursor (-1) - Arrow cursor constant (-2) - Cross cursor constant (-3) - I-Beam cursor constant, often used in text editors (-4) - Sizing cursor constant (-22), alias for crSizeAll. - crSizeNESW - cursor constant: runs diagonally from NorthEast to SouthWest (-6) - - - crSizeNS - cursor constant: cursor runs from North to South (-7) - - - crNWSE - cursor constant: cursor runs from NorthWest to SouthEast - - - Horizontal Size cursor constant (-9) - NorthWest sizing cursor. - - - crSizeN - cursor constant: cursor North (-24) - - - crSizeNW - cursor constant: NorthWest (-23) - - - West (left) sizing cursor. - - - East (right) sizing cursor. - SouthWest sizing cursor. - - - South (bottom) sizing cursor. - - - SouthEast sizing cursor. - - - Up Arrow cursor constant (-10) - Busy cursor constant (wait while action proceeds) (-11) - Dragging cursor constant (-12) - No Drop Allowed dragging cursor constant (-13) - Horizontal Splitter cursor constant (-14) - Vertical Split cursor constant (-15) - Multiple Object dragging cursor constant (-16) - Waiting for SQL cursor constant (-17) - "No" cursor constant (-18), see also . - Application starting[?] cursor. - - - "What's This" Help cursor constant (-20) - Pointing hand cursor constant (-21) - All Directions sizing cursor constant (-22) - Lowest defined cursor constant (-30). - + [?] @@ -801,7 +805,7 @@ - As long as Name=Text, changing the Name will set the Caption + As long as Name=Text, changing the Name will set the Caption. When for example a button's Name and Caption have the value 'Button1' and the Name is changed to 'Button2' then the Caption is changed as well. When Name and Caption differs this flag has no effect. This flag has no effect during loading. @@ -886,7 +890,7 @@ - + control can not be selected at design time @@ -894,7 +898,7 @@ - if the preferred size is 0x0 then control is shrinked ot 0x0 + if the preferred size is 0x0 then control is shrinked to 0x0 @@ -902,7 +906,7 @@ - when AutoSize=true do not move children vertically + when AutoSize=true do not move children vertically @@ -932,57 +936,42 @@ - - - - - - - - - - - - - - - - - Set of permissible Control States + + Set of permissible Control states @@ -994,31 +983,11 @@ TCanvas - - - - - - - - - - - - - - - - - - + + + - - - - - - + @@ -1060,7 +1029,7 @@ - TDragImageList - a list of Images to be dragged + TDragImageList - a list of Images for dragging.

A drag image is shown when a DragImageList is supplied at all, and when no accepting target is under the mouse, or the source control style includes csDisplayDragImage, or AlwaysShowDragImage is set in the DragObject.

@@ -1068,64 +1037,29 @@ 
This is a vague idea of the usage of this class:
 
 SetDragImage selects an image from the list, and defines the hotspot within this image.
+  (the hotspot typically is the offset of the mouse position to the origin of the dragged control)
 
-DragLock specifies a window (handle), to which the image should be attached [what exactly does this mean?]
+BeginDrag starts dragging, the image is shown at the starting location.
 
-ShowDragImage shows the image, combined with the mouse cursor. The HotSpot indicates the shift of the image, relative to the current mouse position.
+DragMove moves the image.
 
-HideDragImage hides the image, shown at its last position.
+EndDrag stops dragging, the image is removed from the screen.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + - - - + Remember position where the image was painted. - - - - + window where drag started and locked via DragLock, invalid=NoLockedWindow=High(PtrInt) - - - - - - + @@ -1134,7 +1068,7 @@ HideDragImage hides the image, shown at its last position. - Initialize the list of images for dragging + Initialize the list of images for dragging. @@ -1144,77 +1078,77 @@ HideDragImage hides the image, shown at its last position. - BeginDrag - start the drag process; returns True if successful - + BeginDrag - start the drag process; returns True if successful. + + Locks window updates[?], remembers the current cursor shape and sets the new shape. + - + True if successful. - + The associated (locked) window. - + The mouse[?] position. - + The mouse[?] position. + - - DragLock - returns True if dragging has been locked for the specifies window at given location + Show drag image and lock updates of Window during drag operation. - + True if Dragging and image shown. - + The locked window. - + The mouse[?] position. - + The mouse[?] position. - DragMove - move dragged images to specified location and return True if successful - + DragMove - move the dragged image to specified location and return True if successful + The image at the old position is erased. - + True if Dragging and image moved. - + The new mouse position. - + The new mouse position. - - DragUnlock - unlock the list of images for dragging + Hide drag image and unlock window updates. - - EndDrag - retuns True if the drag process has ended + Finish dragging of the image. - + [?] @@ -1223,35 +1157,34 @@ HideDragImage hides the image, shown at its last position. - - HideDragImage - method for making dragged image invisible + Hide dragging image without unlocking the window. - Determines the image to be shown + Set index of dragging image and hotspot. - + Always True[?] - + List index of the image to use. - + Offset from mouse position to image position. - + Offset from mouse position to image position. - ShowDragImage - display the dragged image + ShowDragImage - display the dragged image. @@ -1259,27 +1192,27 @@ HideDragImage hides the image, shown at its last position. - DragCursor - the cursor for use during the dragging process + DragCursor - the cursor shape to use while dragging. - DragHotspot - the position of the HotSpot (usually the pointer of the cursor) + DragHotspot - the position of the HotSpot, i.e. the offset from the mouse position while dragging. - Dragging - True if dragging is proceeding + Dragging - True if dragging in progress. - + [?] @@ -1294,7 +1227,7 @@ HideDragImage hides the image, shown at its last position. - + [?] @@ -1314,7 +1247,7 @@ HideDragImage hides the image, shown at its last position. - + [?] @@ -1335,7 +1268,7 @@ HideDragImage hides the image, shown at its last position. - + [?] @@ -1353,7 +1286,7 @@ HideDragImage hides the image, shown at its last position. - + [?] @@ -1374,7 +1307,7 @@ HideDragImage hides the image, shown at its last position. - + [?] @@ -1392,47 +1325,43 @@ HideDragImage hides the image, shown at its last position. - - + State changes while dragging - when mouse enters, leaves or moves over a control. + These values are sent with drag messages, allowing the control to perform special actions while the mouse moves over it. + - - + Mouse has just entered the control. - - + Mouse has just left the control. + + + Mouse is moving over the control. - - - + Indicates whether dragging can start automatically. - - + Dragging can start only by explicit code. - - + Dragging starts when the left mouse button is pressed on the control. - + Indicates whether the control performs drag-drop or drag-dock. - - + Control is dragged for dropping. - - + Control is dragged for docking. @@ -1440,17 +1369,14 @@ HideDragImage hides the image, shown at its last position. - - + Dragging not started. - - + Drag-drop started. - - + Drag-dock started. @@ -1466,27 +1392,21 @@ dmFindTarget: find child control under the mouse - mouse enters control - mouse leaves control - mouse moves over control (after dmDragEnter) - control dropped - dragging aborted - find possible target control under the mouse @@ -1593,29 +1513,17 @@ dmFindTarget: find child control under the mouse - - - - - - - - - - - - @@ -1640,23 +1548,17 @@ dmFindTarget: find child control under the mouse - - - - - - - - - - - - - + + + + + + + + [Delphi compatible - dropped!] - [Delphi compatible - dropped!] @@ -1688,7 +1590,7 @@ dmFindTarget: find child control under the mouse - Returns the dragging cursor type. + Returns the dragging cursor type (shape). In drag-drop operations the cursor signals acceptance or rejection of an drop, depending on Accepted. @@ -1700,10 +1602,10 @@ dmFindTarget: find child control under the mouse Which cursor to return (rejected:crNoDrop or accepted:crDrag). - + [?] - + [?] @@ -1809,18 +1711,6 @@ dmFindTarget: find child control under the mouse - - - - - - - - - - - - Remembers the dragged control. @@ -1845,9 +1735,7 @@ dmFindTarget: find child control under the mouse This is a Lazarus specific property, introduced to get rid of the special Delphi TDrag...Ex classes. - - - + Should the image of dragged objects always be shown? @@ -1953,7 +1841,7 @@ dmFindTarget: find child control under the mouse The default implementation calls Control.DoEndDrag, which in turn invokes an OnEndDrag handler. - + The control onto which the dragged object is dropped (can be Nil). @@ -2029,19 +1917,15 @@ dmFindTarget: find child control under the mouse - no orientation applies (like alNone) - siblings are arranged horizontally, children top-to-bottom - siblings are arranged vertically, children left-to-right - children are pages in a tabbed control @@ -2127,7 +2011,7 @@ dmFindTarget: find child control under the mouse An OnGetSiteInfo handler returns information about a docksite. - An OnGetSiteInfo event is sent by the DragManager to the nearest docksite. + An OnGetSiteInfo event is sent by the DragManager to all docksites. The handler can adjust the snapping rectangle (InfluenceRect), and can reject an drop. @@ -2142,7 +2026,7 @@ dmFindTarget: find child control under the mouse The screen rectangle within which a drop or mouse move will be directed to this docksite. - The current position of the mouse. + The current [screen?] position of the mouse. Set CanDock to False to reject docking. @@ -2161,17 +2045,17 @@ dmFindTarget: find child control under the mouse - - [dropped!] - - - - + + + [dropped!] + + + [Delphi compatible - dropped!] @@ -2182,9 +2066,6 @@ dmFindTarget: find child control under the mouse - - The hotspot offset of the dragged DockRect. - Adjust the DockRect relative to the dragging hotspot (DockOffset). @@ -2289,12 +2170,7 @@ dmFindTarget: find child control under the mouse - - - - - - + [Delphi compatible - dropped!] @@ -2362,7 +2238,7 @@ dmFindTarget: find child control under the mouse Every docksite can have an DockManager, which handles dropping and arranges the docked controls. - + @@ -2537,7 +2413,7 @@ dmFindTarget: find child control under the mouse - ResetBounds refreshes the layout of the docksite + ResetBounds refreshes the layout of the docksite.

This method typically notifies the DockManager of a Resize of the docksite.

When the extent of the docksite really has changed, the DockManager should reposition and resize all docked controls accordingly.

@@ -2597,38 +2473,30 @@ dmFindTarget: find child control under the mouse - + [?] - + [?] - - + [?] - - + [?] - - + [?] - - + [?] - - - - - + Holds maximum and minimum values that can be used in sizing objects. @@ -12502,31 +12370,6 @@ and that description should be read to understand their definitions more fully. - - - - - - - - - - - - - - - - - - - - - Array of names for the elements. - - The names include the "al;" prefix, e.g. alNone. - - Get control at screen position. @@ -12965,30 +12808,6 @@ and that description should be read to understand their definitions more fully. - - - - - - - - - - - - - - - - - - - - - - - - @@ -13560,30 +13379,6 @@ capfHasScrollOffset: crap, ScrollOffset is taken into account only for the first - - - - - - - - - - - - - - - - - - - - - - - - Converts items of several data types into strings, for debug output. diff --git a/docs/xml/lcl/imglist.xml b/docs/xml/lcl/imglist.xml index 4b6c244ae6..a0815eaebf 100644 --- a/docs/xml/lcl/imglist.xml +++ b/docs/xml/lcl/imglist.xml @@ -7,89 +7,11 @@ ==================================================================== --> - Contains definitions for TCustomImageList. base class for TImageList + Contains definitions for TCustomImageList, the base class for TImageList. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + [?] @@ -102,24 +24,10 @@ - - - - - - - - - - - + + - - - - - - + @@ -144,128 +52,74 @@ - + [?] - - + [?] - - + [?] - - + [?] - - + [?] - + [?] - + [?] - + [?] Base class for TImageList (not the same as a TBitmap collection) - An ImageList contains images (bitmaps or icons) of the same Width and Height, accessible by index. The images are stored in one big (wide) bitmap, whose width is Width*Count. When an image of a different Width or Height is inserted, the previous contents of the list are discarded! - -It's okay, however, to insert an imagelist-like bitmap, that contains multiple bitmaps of the same Width and Height as used by the ImageList. This allows to insert e.g. other (compatible) ImageLists, or bitmaps for multiple states of essentially the same image (button pressed, released and disabled). - -Transparency is implemented in the alpha channel of the raw 32 bit RGBA imagedata array - but not all platforms support such an alpha channel. [What exactly does this mean to the user?] - -The painting of an image from the list is handled by the widgetset, no bitmap or icon component is involved. The widgetset can use a different internal organization of the data, optimized for immediate painting of an image. - -NOTE: A TCustomImageList is not a TBitmap collection. -If a storage of distinct bitmaps is needed, create your own list of TBitMaps (array or TList). + +

An ImageList contains images (bitmaps or icons) of the same Width and Height, accessible by index. + The images are stored in one big (wide) bitmap, whose width is Width*Count. +

When an image of a different Width or Height is inserted, the previous contents of the list are discarded! +

+ It's okay, however, to insert an imagelist-like bitmap, that contains multiple bitmaps of the same Width and Height as used by the ImageList. + This allows to insert e.g. other (compatible) ImageLists, or bitmaps for multiple states of essentially the same image (button pressed, released and disabled). +

+ Transparency is implemented in the alpha channel of the raw 32 bit RGBA imagedata array - but not all platforms support such an alpha channel. + [What exactly does this mean to the user?] +

+ The painting of an image from the list is handled by the widgetset, no bitmap or icon component is involved. + The widgetset can use a different internal organization of the data, optimized for immediate painting of an image. +

+ NOTE: A TCustomImageList is not a TBitmap collection. + If a storage of distinct bitmaps is needed, create your own list of TBitMaps (array or TList). +

[What about Mask and ShareImages?] +

+ Currently only the insertion of Bitmaps is supported. Other image types should be rendered as bitmaps of Width and Height, which then can be inserted. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + @@ -273,13 +127,7 @@ If a storage of distinct bitmaps is needed, create your own list of TBitMaps (ar - - - - - - - + @@ -291,136 +139,146 @@ If a storage of distinct bitmaps is needed, create your own list of TBitMaps (ar - - - - - - - - - - - - - - - - + + + + + + - - - - - + + Allocates data for ACount images + + + + + + - - - + + the number of images + + + + Insert bitmap (with split if necessary) into position AIndex with shifting other images. + + + Index to insert images + + + Image handle + + + Mask handle + + + Width in pixels + + + Height in pixels + + + [?] + + + + Moves an image from CurIndex to NewIndex, without notifying the widgetset. + + + + + + + + + the index of the image to be moved + + + the new index of the image + + + [?] + + + + [?] + + + + + + + + + + + + + + + + + + + Copies the imagedata into the FData array and then frees the image. + + + + + + + + + Pointer to the updated image data + + + the index of the location where the image should be set + + + the new image - + Internal function to notify the subscribed objects of a change of the imagelist. - - - - - - - + - - - - - - - + - - - - - - - + - - - - - - - + - - - - - - - + - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + @@ -429,29 +287,13 @@ If a storage of distinct bitmaps is needed, create your own list of TBitMaps (ar - - - - - - - - - - - - - - - - - - - Initialize - sets up the list - + + Initializes the internal bitmap structures and the changelink list. + It is used by the Create and CreateSize constructors. + @@ -463,56 +305,35 @@ If a storage of distinct bitmaps is needed, create your own list of TBitMaps (ar - - SetWidthHeight - specifies the dimensions for display - + SetWidthHeight - set Width and Height of the images. + Writing clears the entire list. - - - - - - - - - - + + - - - - - - - + - - - - - - - + @@ -523,7 +344,6 @@ If a storage of distinct bitmaps is needed, create your own list of TBitMaps (ar - @@ -534,25 +354,26 @@ If a storage of distinct bitmaps is needed, create your own list of TBitMaps (ar - - BeginUpdate - start updating the data - Use together with EndUpdate to speed up the insertion of multiple images. - -Every BeginUpdate must be matched by an EndUpdate, i.e. update operations can be nested. - + Start updating the data, block the OnChange event. + +

Use together with EndUpdate to speed up the insertion of multiple images. +

+ Every BeginUpdate must be matched by an EndUpdate, i.e. update operations can be nested. +

+ - EndUpdate - finish updating the data + EndUpdate - finish updating the data, call Change. Decrements the internal UpdateCount and, when it reaches zero, does whatever is required to reflect the new content. @@ -564,74 +385,37 @@ Every BeginUpdate must be matched by an EndUpdate, i.e. update operations can be Add an Image and Mask bitmap to the list. Returns the index of the added image or -1 if unsucessful - + +
+  Adds one or more (bitmap width / imagelist width) bitmaps to the list.
+  If Mask is nil, the image has no transparent parts.
+
+ - - + The index of the added image, -1 if unsuccesful. - - + a bitmap image - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + a bitmap which defines the transparent parts of Image - Adds an icon to the list (not yet!), returning the index of the icon or -1 if not successful - Adding graphics other than bitmaps can be implemented by converting the graphics item into a bitmap, which then can be added to the image list. Most graphics classes support such a conversion, so that specialized methods are redundant. + Adds an icon to the list [not yet!?], returning the index of the icon or -1 if not successful + Adding graphics other than bitmaps can be implemented by converting the graphics item into a bitmap, which then can be added to the image list. + Most graphics classes support such a conversion, so that specialized methods are redundant. - - + The index of the added icon, -1 if unsuccesful. - - + the Icon to be added. @@ -641,53 +425,53 @@ Every BeginUpdate must be matched by an EndUpdate, i.e. update operations can be - - - + + + AValue - the ImageList containing images to add AddMasked - adds one or more bitmaps to the list - Every pixel of MaskColor will become transparent. + +
+Every pixel of MaskColor will become transparent.
 
 Image can contain multiple images of the same Width and Height.
 
-Returns the index of the first added bitmap, or -1 if unsuccessful.
+Returns the index of the first added bitmap, or -1 if unsuccessful.
+
+ - - + The index of the [last?] added icon, -1 if unsuccesful. - - + A bitmap to be added - - + The color acting as transparant color - - - - - + + + AddLazarusResource - load TBitmap from lazarus resources and add it - - - + + [?] - - - + + [?] + + + [?] - Change - send change notifications + Change - send change notifications. Notifies all members of the ChangeLinkList, and calls the OnChange handler. @@ -695,7 +479,7 @@ Returns the index of the first added bitmap, or -1 if unsuccessful. - Clear - removes all images from the list + Clear - removes all images from the list. @@ -703,36 +487,30 @@ Returns the index of the first added bitmap, or -1 if unsuccessful. Initialize the list for image(s) with the given height and width - The Width and Height is reset with every insertion of a bitmap. It may be useful, however, to initialize a list for the insertion of graphics other than bitmaps, so that the images can be rendered as bitmaps of the intended width and height, before they are inserted. + The Width and Height is reset with every[? first only?] insertion of a bitmap. + It may be useful, however, to initialize a list for the insertion of graphics other than bitmaps, + so that the images can be rendered as bitmaps of the intended width and height, before they are inserted. - - + The width of all images, in pixels. - - + The height of all images, in pixels. - Delete the specified image + Delete the specified image(s) - - - + + the index of the image to be deleted. -1 for delete all. - - - - - - + Paint an image @@ -740,25 +518,29 @@ Returns the index of the first added bitmap, or -1 if unsuccessful. - - - + + - - - + + - - - + + - - - + + The image index. - - - + + If False, draw the image disabled. + + + + + + + + + @@ -767,71 +549,28 @@ Returns the index of the first added bitmap, or -1 if unsuccessful. - - + the index of the requested image - - + a bitmap as a container for the bitmap - - - - - - - - - - - - - - - - - - - - - - + + how to copy - GetHotSpot - returns the co-ordinates for the hotspot of the drag image + GetHotSpot - returns the offset from the drawing[?] position to the image origin. - - - - - - - - - - - - - - - - - - - - - - + @@ -848,32 +587,27 @@ If Mask is nil, the inserted images have no transparent parts. - - - + + insert position - - - + + bitmap to insert - - - + + transparency mask, Nil for opaque - + Insert an Icon into the list. - - - + + insertion point - - - + + The Icon to insert. @@ -885,22 +619,19 @@ If Mask is nil, the inserted images have no transparent parts. - - + The index of the inserted image - - - + + The bitmap to be inserted - - + The color acting as transparant color - Move an image from index CurIndex to NewIndex + Move an image from index CurIndex to NewIndex @@ -908,70 +639,47 @@ If Mask is nil, the inserted images have no transparent parts. - - - + + the index of the image to be moved - - - + + the new index of the image - Replace an indexed image with the Bitmap given + Replace the indexed image with the Bitmap given AMask can be nil, if the image has no transparent parts. - - - + + the index of the replaceded image - - - + + a bitmap image - - - - - - - - - - - - - - - - - - + + a bitmap which defines the transparent parts of Image ReplaceMasked - replaces the indexed image with the image given. - Every instance of MaskColor will be converted to transparent + Every pixel of MaskColor will be converted to transparent - - + the index of the replaceded image - - + A bitmap image - - + The color acting as transparant color @@ -980,40 +688,38 @@ If Mask is nil, the inserted images have no transparent parts. - - + a reference to changelink object - UnRegisterChanges - remove the changes from the register + Unregisters an notification object. - - + Reference to the changelink object to remove. - AllocBy - allocate images by an integer value + AllocBy - the number of images in every allocated block. - BlendColor - the colour for a blend + BlendColor - the colour for a blend[???] - BkColor - background colour (default none) + The background color for transparent parts. @@ -1032,23 +738,17 @@ If Mask is nil, the inserted images have no transparent parts. - - - - - - - Height of images on list - + Height of the images in the list. + Writing clears the entire list. - Width of images on list - + Width of all images in the list + Writing clears the entire list. @@ -1061,26 +761,14 @@ If Mask is nil, the inserted images have no transparent parts. - Masked - if True, a mask is applied to the bitmap - - - - - - - - - - - - + Masked - if True, a mask [what's this?] is applied to the bitmap. - ShareImages - if True, images are allowed to be shared + ShareImages - if True, images are allowed to be shared[???] @@ -1091,22 +779,45 @@ If Mask is nil, the inserted images have no transparent parts. - - - AValue - the ImageList containing images to add - - - - AddLazarusResource - load TBitmap from lazarus resources and add it - FillDescription - fills the description with the default info of the imagedata + + the description to fill + + + + [?] + + + + + + + + + the target bitmap + + + how to copy + + + Copies the image description and the data pointer + + + + GetRawImage - primitive method for loading an image: you have to fill in all the description fields yourself + + the index of the image to copy + + + the target bitmap + Reference to the imagelist @@ -1115,26 +826,54 @@ If Mask is nil, the inserted images have no transparent parts. CheckIndex - method for checking whether the indexed item is supposed to be inserted (default condition is False) + + + + + + GetReferenceHandle - returns a handle for the reference + + + - WSCreateReference - creates a reference for the Imagelist (returns this as a result), passing the defined parameters for the creation process + Instructs the widgtset to create an imagelist. + + + Handle to created imagelist + + + ignored - StretchDraw - draw the image to fill the canvas + Draws an image stretched to ARect. + + + [?] + + + [?] + + + [?] + + + [?] - - Check for equivalence with another ImageList This is an expensive operation, since both imagelists are written into memory streams, which then are compared bytewise. - - Copies the image description and the data pointer + + + + +