Help File/Documentation Issues. (Discussion Only)

[AZJIO]

@BrewManNH

True - back
False - forward

If $fWrapOK = True search will continue

I think here there was referring to continued forward, which means "False"

Work-in-progress

It is possible to do without these functions: _GUIToolTip_BitsToTTF, _GUIToolTip_TTFToBits

If BitAND($iFlags, 1) <> 0 Then $iN = BitOR($iN, $TTF_IDISHWND)

If BitAND($iFlags, 1) Then $iN = BitOR($iN, $TTF_IDISHWND)

Edited October 8, 2013 by AZJIO

[BrewManNH]

@BrewManNH

True - back

False - forward

I think here there was referring to continued forward, which means "False"

No it means to wrap around from one end of the listview to the other, from last to first or from first to last, and then continue searching for the text.

It is possible to do without these functions: _GUIToolTip_BitsToTTF, _GUIToolTip_TTFToBits

If BitAND($iFlags, 1) <> 0 Then $iN = BitOR($iN, $TTF_IDISHWND)

If BitAND($iFlags, 1) Then $iN = BitOR($iN, $TTF_IDISHWND)

Yes, that's part of my update. I'm finding a lot of the tooltip functions don't even work so some of those may be gone as well.

[guinness]

I think that this information may be useful such a member like me, that are actively involved in the work on the documentation.

Well that as well as other areas of the documentation. If there were any script breaking changes it would be documented.

[AZJIO]

_GUIToolTip_AddTool

$hTool ToolTip handle

$hWnd Handle to the window that contains the tool

_GUIToolTip_DelTool

$hWnd Handle to the control

$hTool Handle to the window that contains the tool

At many functions names of variables are confused

_GUIToolTip_NewToolRect

$iID Application-defined identifier of the tool

[guinness]

I'm not really following this thread that strictly, so I will continue to look at Trac.

[AZJIO]

_GUICtrlRichEdit_GetCharWordBreakInfo
the "GetWord" and "Report" function aren't used.

_GUICtrlRebar_...
_GUICtrlRebar_SetBandBackColor($hReBar, 1, Int(0x00008B))
_GUICtrlRebar_SetBandForeColor($hReBar, 1, Int(0xFFFFFF))

By the way, why these lines in all the examples

_GUICtrlRebar_BeginDrag
Adds a new band in a rebar control

_GUICtrlRebar_GetBandChildHandle
$iIndex 0-based index of the band for which the borders will be retrieved

_GUICtrlRebar_GetBandMargins, _GUICtrlRebar_GetBandMarginsEx
Get Length of the band, in pixels

Edited October 10, 2013 by AZJIO

[mLipok]

in documentation to: _GUICtrlListView_DrawDragImage()

in Description section: there is: "Draw the Drage Image"

Perhaps it was my poor knowledge of English, but the words did not sound to me properly.

Possible it was a shortcut or not known to me lexical form.

Can anyone verify my English knowledge in this area?

[czardas]

I have no idea what it means either. I found nothing about it.

http://en.wikipedia.org/wiki/Drage

http://en.wikipedia.org/wiki/Drag%C3%A9

I assume the word was intended to be 'drag', but then the English would still be meaningless. Maybe the word 'draggable' would fit. I'm unsure what the purpose is.

Edited October 14, 2013 by czardas

[Melba23]

mlipok & czardas,

A "drag image" is created by the _GUICtrlListView_CreateDragImage function and attaches to the mouse cursor. it is most often used when dragging a ListViewItem within, or indeed between, ListViews and is usually limited to the first item only if there are multiple items selected. Example 1 of my GUIListViewEx UDF shows such a "drag image" when you drag items on either of the two ListViews.

However, the _GUICtrlListView_DrawDragImage function seems to create a "drag image" from a preset image list rather than the selected item - as can be seen from the example. I will amend the description of the function accordingly - and correct the spelling.

M23

[czardas]

Thanks for the new info. I don't see what's wrong with the word draggable, but best to go with the flow. haha!

[czardas]

_ArrayUnique is described as returning unique entries of a 1 dimensional array. Then there are examples of passing 2 dimensional arrays to the function. The description is wrong..

Edited October 15, 2013 by czardas

[jaberwacky]

Honestly, the description sounds fine to me.  A user passes _ArrayUnique a 2D array and specifies the second dimension, then it will return a list of elements unique to that dimension.

[BrewManNH]

I've been complaining about the description of ArrayUnique for 2 years, the description is pretty much totally wrong for what it does, and what it returns. Which reminds me, I can fix that now.

 

Honestly, the description sounds fine to me.  A user passes _ArrayUnique a 2D array and specifies the second dimension, then it will return a list of elements unique to that dimension.

The description doesn't say that though, and by the way, the returned elements are not the unique elements of the dimension of the array, they're the elements of the array with all duplicates removed. It MAKES the array have unique elements, it does not return the ones that are.

Edited October 16, 2013 by BrewManNH

[jaberwacky]

It MAKES the array have unique elements, it does not return the ones that are.

That would imply that it operates on the array in place, but since it doesn't it returns an array of unique elements.

[BrewManNH]

Unique to that dimension implies to me that it's only returning the elements that are already unique in it, which is not what it does. The elements in the returned array have to come from somewhere, even though it's not byref, it's still returning the elements from the incoming array, removing all duplicates, and returning just the unique elements. Hence, it makes the elements unique, it doesn't return the unique elements.

If it were to return the unique elements from the incoming array, it would only return the elements that have no duplicates in the first place and discard all the elements that are duplicated. So an array with 1,2,3,3,3,4,5 would return 1,2,4,5 if it were truly returning the unique elements.

BTW, I have updated the help file description for _ArrayUnique to accurately describe what it does.

[jaberwacky]

Then shouldn't the first example in the helpfile return nothing?

[czardas]

The description is misleading because it is inacurate.

Returns the unique elements of a 1 dimensional array

 

This implies what it says and nothing more. It gives the impression (note this is important) that it does not work with multidimensional arrays. Since it clearly does work with multidimensional arrays, it is now unclear to me exactly what it does. The returned array is 1 dimensional - it isn't even returning a unique 2D array.

In any case this forum has many non native English speakers and I consider it to be vitally important that descriptions undergo the same degree of scrutiny as the code they describe. Going by the description, I would expect a 2D array to throw an error.

[jaberwacky]

I can't believe I was arguing about the return statement and everyone else was focused on the description.  *facepalm*  sorrry.

[czardas]

@Jabberwocky No worries!

Also from _ArrayUnique() ...2nd parameter

$iDimension - The dimension of the array to use

 

This doesn't make any sense to me, sorry. If the array has 2 dimensions, it is both impossible and meaningless to use only the first dimension. This also needs to be changed. There are people out there who are struggling with basic concepts. How is it possible to search for unique items in the 4th dimension of a two dimensional array? ^^

Edited October 16, 2013 by czardas

[BrewManNH]

_ArrayUnique only searches through one of the arrays dimensions, that parameter lets you select which of the 2 (if a 2D array) you're going to work with.