Class MenuComponent

Summary

#
  This is the superclass of all the objects that make up the
  menu system (other than the top level {Components} of course).

  For components that appear in a menu with a label, an
  optional left/right string/image can be set.

Superclasses:
MetaComponent

Package:
(main)
File:
menucomponent.icn
Methods:
clear_is_shaded, display_label, error, get_label, is_shaded, is_sub_menu, select_event, set_abs_coords, set_abs_size, set_img_left, set_img_right, set_is_shaded, set_label, set_label_left, set_label_pos, set_label_right, set_label_size, set_parent_menu, set_parent_menu_bar, toggle_is_shaded

Methods inherited from MetaComponent:
set_fields

Fields:
h, img_left, img_left_h, img_left_w, img_right, img_right_h, img_right_w, is_shaded_flag, is_sub_menu_flag, label, label_h, label_left, label_left_w, label_mid_w, label_right, label_right_w, label_x, label_y, parent_menu, parent_menu_bar, w, x, y

Source code.

Details
Constructor

MenuComponent(argv)

Methods:

clear_is_shaded()

#
  Set the shaded status of the component to not shaded.


display_label()


error(s)


get_label()


is_shaded()


is_sub_menu()


select_event()


set_abs_coords(x, y)


set_abs_size(w, h)


set_img_left(x)

#
  Set the optional left image to the given Icon image.


set_img_right(x)

#
  Set the optional right image to the given Icon image.


set_is_shaded()

#
  Set the shaded status of the component to shaded.


set_label(x)

#
  Set the centre label to the given string.


set_label_left(x)

#
  Set the optional left label to the given string.


set_label_pos(x, y)


set_label_right(x)

#
  Set the optional right label to the given string.


set_label_size()


set_parent_menu(x)


set_parent_menu_bar(x)


toggle_is_shaded()

#
  Toggle whether or not the item is shaded.  If it is, it is
  displayed in a filtered way and will not accept input.


Fields:
h

img_left

img_left_h

img_left_w

img_right

img_right_h

img_right_w

is_shaded_flag

is_sub_menu_flag

label

label_h

label_left

label_left_w

label_mid_w

label_right

label_right_w

label_x

label_y

parent_menu

parent_menu_bar

w

x

y


This page produced by UniDoc on 2021/04/15 @ 23:59:53.