Module: AMS::Menu

Defined in:
docs/ams/menu.rb

Overview

Note:

Windows only!

The Menu namespace contains functions associated with Windows menu.

Since:

  • 2.0.0

Class Method Summary collapse

Class Method Details

.end ⇒ Boolean

Deactivate active context menu.

Returns:

  • (Boolean) —

    success

See Also:

Since:

  • 2.0.0

.get_commands(handle, cur_path = "") ⇒ Hash<String, Integer>

Get menu commands.

Parameters:

  • handle (Integer) —

    A handle to a valid menu or sub-menu.

  • cur_path (String) (defaults to: "") —

    Current menu path.

Returns:

  • (Hash<String, Integer>) —

    { path => id, ... }

Since:

  • 2.0.0

.get_item_count(handle) ⇒ Integer

Get menu item count.

Parameters:

  • handle (Integer) —

    A handle to a valid menu or sub-menu.

Returns:

  • (Integer) —

    count

See Also:

Since:

  • 2.0.0

.get_item_id(handle, index) ⇒ Integer?

Note:

A return value of zero implies the menu item is a separator.

Get menu item id by item position.

Parameters:

  • handle (Integer) —

    A handle to a valid menu or sub-menu.

  • index (Integer)

Returns:

  • (Integer, nil) —

    Menu item identifier if successful or -1 if not.

See Also:

Since:

  • 2.0.0

.get_item_string_by_id(handle, id) ⇒ String?

Get menu item string by item identifier.

Parameters:

  • handle (Integer) —

    A handle to a valid menu or sub-menu.

  • id (Integer)

Returns:

  • (String, nil) —

    Menu item string if successful or nil if not.

See Also:

Since:

  • 3.0.0

.get_item_string_by_pos(handle, index) ⇒ String?

Get menu item string by item position.

Parameters:

  • handle (Integer) —

    A handle to a valid menu or sub-menu.

  • index (Integer)

Returns:

  • (String, nil) —

    Menu item string if successful or nil if not.

See Also:

Since:

  • 3.0.0

.get_sub_menu(handle, index) ⇒ Integer?

Get menu sub-menu handle by sub-menu position.

Parameters:

  • handle (Integer) —

    A handle to a valid menu or sub-menu.

  • index (Integer)

Returns:

  • (Integer, nil) —

    A handle to sub-menu if successful or nil if not.

See Also:

Since:

  • 2.0.0

.is_item_checked_by_id?(handle, id) ⇒ Boolean

Determine if menu item is checked.

Parameters:

  • id (Integer)

Returns:

  • (Boolean) —

    True if checked; false if unchecked.

Since:

  • 3.6.0

.is_item_checked_by_pos?(handle, index) ⇒ Boolean

Determine if menu item is checked.

Parameters:

  • index (Integer)

Returns:

  • (Boolean) —

    True if checked; false if unchecked.

Since:

  • 3.6.0

.is_item_grayed_by_id?(handle, id) ⇒ Boolean

Determine if menu item is grayed.

Parameters:

  • id (Integer)

Returns:

  • (Boolean) —

    True if grayed/disabled; false if enabled.

Since:

  • 3.6.0

.is_item_grayed_by_pos?(handle, index) ⇒ Boolean

Determine if menu item is grayed.

Parameters:

  • index (Integer)

Returns:

  • (Boolean) —

    True if grayed/disabled; false if enabled.

Since:

  • 3.6.0

.is_valid?(handle) ⇒ Boolean

Determine whether handle is a reference to a valid menu.

Parameters:

  • handle (Integer) —

    A menu handle to be tested.

Returns:

  • (Boolean)

See Also:

Since:

  • 2.0.0

.set_item_string_by_id(handle, id, string) ⇒ Boolean

Set menu item string by item identifier.

Parameters:

  • handle (Integer) —

    A handle to a valid menu or sub-menu.

  • id (Integer)
  • string (String)

Returns:

  • (Boolean) —

    success

See Also:

Since:

  • 3.0.0

.set_item_string_by_pos(handle, index, string) ⇒ Boolean

Set menu item string by item position.

Parameters:

  • handle (Integer) —

    A handle to a valid menu or sub-menu.

  • index (Integer)
  • string (String)

Returns:

  • (Boolean) —

    success

See Also:

Since:

  • 3.0.0