CWinContents

class CWinContents
_images/CWinContents.png

CWinContents has a role as a container for holding the various controls .

CWinContents is used in the following part.

  • CWindowBase has a CWinContents. Thereby , a window can have some controls.

  • CWinCtrlBase has a CWinContents. (This window system calls it the contents. Please refer to here ).

  • CWinCtrlBase has it in a list form. This window system calls it the contents list.

The first two are defined structure by the window script.

The contents list(third) has a lot of contents by the list form.

Functions / Properties

WinCtrl find<WinCtrl> (UInt32 ctrlId)
Param uint ctrlId

Control ID

Locate the control with the specified ID. If it doesn’t exist in the content, it recursively looks in the content of the control.However, the content list is not included in the search. This ensures that the control is unique.

Int32 getIndex (UInt32 ctrlId)
Param uint ctrlId

Control ID

Locates the position of the specified control ID in the list. If not found, -1 is returned. Unlike find, it does not search recursively.

The returned index value can be used with this [N] for fast access.

CWinCtrlBase this[, Int32 N] { get; }

You can use the index value obtained by ” getIndex ” .

Int32 count { get; }

Returns the number of controls in the content.

ClipRect.State clipState { get; }

It uses for the contents included within the contents list. (ex: LISTBOX , LISTBOXEX ).

ClipRect.State.Inside

Completely within the region

ClipRect.State.Clipped

Clipping is necessary.

ClipRect.State.Outside

Rendering is unnecessary (completely outside the region)

Single width { get; }

Gets the width of the content. Automatically calculated from the size of the control.

Single height { get; }

Gets the height of the content. Automatically calculated from the size of the control.

Vector2 size { get; }

Gets the size of the content. Automatically calculated from the size of the control.

Vector3 position { get; }

Display position of the content

CWinCtrlBase parent { get; }

Gets the control that is the parent of the content.

if the parent of this contents is CWindowBase ,it returns a null.