View

A View is a rectangle within the View hierarchy.

Constructors

hime_view_t hime_view_create()

Create a new View.

Return

Methods

void hime_view_set_visible(self, visible)

Show/Hide the view.

Parameters

• hime_view_t self
• bool visible

Return

bool hime_view_is_visible(self)

Return whether the view is visible.

Parameters

• hime_view_t self

Return

void hime_view_set_enabled(self, enabled)

Set whether the view is enabled.

Parameters

• hime_view_t self
• bool enabled

Return

bool hime_view_is_enabled(self)

Return whether the view is enabled.

Parameters

• hime_view_t self

Return

hime_rect_t hime_view_get_bounds(self)

Return the bounds of the view in its parent's coordinates.

Parameters

• hime_view_t self

Return

void hime_view_set_preferred_size(self, size)

Sets or unsets the size that this View will request during layout.

Parameters

• hime_view_t self
• hime_size_t* size

Return

hime_size_t hime_view_get_preferred_size(self)

Return the size the view would like to be under the current bounds.

Parameters

• hime_view_t self

Return

void hime_view_set_style(self, name, value)

Change the styles of the view.

Note that calling this method does not changes the bounds immediately, the bounds will change when the view hierarchy re-calculates the layout, such as when resizing window or when adding/removing child views. To make the new styles apply immediately you can call Layout method.

Parameters

• hime_view_t self
• const char16_t* name
• const char16_t* value

Return

void hime_view_set_style_number(self, name, value)

Change the styles of the view.

Note that calling this method does not changes the bounds immediately, the bounds will change when the view hierarchy re-calculates the layout, such as when resizing window or when adding/removing child views. To make the new styles apply immediately you can call Layout method.

Parameters

• hime_view_t self
• const char16_t* name
• float value

Return

void hime_view_layout(self)

Re-calculate the layout in view hierarchy.

Parameters

• hime_view_t self

Return

void hime_view_set_background(self, background)

Set the background of the view.

Parameters

• hime_view_t self
• hime_background_t background

Return

void hime_view_set_border(self, border)

Set the border of the view.

Note that it is also possible to set border via the SetStyle API, but it only serves as layout property rather than actually drawin a border, while the SetBorder API actually draws the border.

The two types of borders do not know each other and setting both might cause weird visual effects, this will change in future and please be prepared for it.

Parameters

• hime_view_t self
• hime_border_t border

Return

void hime_view_add_child_view(self, view)

Append a child view to this view.

Parameters

• hime_view_t self
• hime_view_t view

Return

void hime_view_add_child_view_at(self, view, index)

Add a child view to this view at index.

Parameters

• hime_view_t self
• hime_view_t view
• size_t index

Return

void hime_view_remove_child_view(self, view)

Remove a child view from this view.

Parameters

• hime_view_t self
• hime_view_t view

Return

size_t hime_view_child_count(self)

Return the count of children in this view.

Parameters

• hime_view_t self

Return

hime_view_t hime_view_child_at(self, index)

Return the child View at index.

Parameters

• hime_view_t self
• size_t index

Return

void hime_view_set_accessible_name(self, name)

Set the accessible name.

The value of the accessible name is a localized, end-user-consumable string which may be derived from visible information (e.g. the text on a button) or invisible information (e.g. the alternative text describing an icon). In the case of focusable objects, the name will be presented by the screen reader when that object gains focus and is critical to understanding the purpose of that object non-visually.

Parameters

• hime_view_t self
• const char16_t* name

Return

const char16_t* hime_view_get_accessible_name(self)

Get the accessible name.

Parameters

• hime_view_t self

Return

void hime_view_set_group(self, group)

Set the group id of this view.

Some view subclasses use this id to find other views of the same group. For example radio button uses this information to find other radio buttons.

Parameters

• hime_view_t self
• int group

Return

void hime_view_get_group(self)

Get the group id of this view.

Parameters

• hime_view_t self

Return

Events

void hime_view_on_draw(view, painter)

Emitted when the drawing of view is done.

Parameters

• hime_view_t view
• hime_painter_t painter

Preventable

No.

bool hime_view_on_will_draw(view, painter)

Emitted when the drawing of view is going to start.

Returning true will prevent the default paint routine of view.

Parameters

• hime_view_t view
• hime_painter_t painter

Preventable

Yes.

Version:

Constructors:

• create

Methods:

• set_visible
• is_visible
• set_enabled
• is_enabled
• get_bounds
• set_preferred_size
• get_preferred_size
• set_style
• set_style_number
• layout
• set_background
• set_border
• add_child_view
• add_child_view_at
• remove_child_view
• child_count
• child_at
• set_accessible_name
• get_accessible_name
• set_group
• get_group

Events:

• on_draw
• on_will_draw