Class: MiniGL::DropDownList

Inherits:
Component show all
Defined in:
lib/minigl/forms.rb

Overview

This class represents a “drop-down list” form component, here composed of a group of Button objects.

Instance Attribute Summary collapse

Attributes inherited from Component

#enabled, #h, #params, #visible, #w, #x, #y

Instance Method Summary collapse

Constructor Details

#initialize(x, y = nil, font = nil, img = nil, opt_img = nil, options = nil, option = 0, text_margin = 0, width = nil, height = nil, text_color = 0, disabled_text_color = 0, over_text_color = 0, down_text_color = 0, retro = nil, scale_x = 1, scale_y = 1, &on_changed) ⇒ DropDownList

Creates a new drop-down list.

Parameters:

x

The x-coordinate of the object.

y

The y-coordinate of the object.

font

Font to be used by the buttons that compose the drop-donwn list.

img

Image of the main button, i.e., the one at the top, that toggles visibility of the other buttons (the “option” buttons).

opt_img

Image for the “option” buttons, as described above.

options

Array of available options for this control (+String+s).

option

Index of the firstly selected option.

text_margin

Left margin of the text inside the buttons (vertically, the text will always be centered).

width

Width of the control, used when no image is provided.

height

Height of the control, used when no image is provided.

text_color

Used as the text_color parameter in the constructor of the buttons.

disabled_text_color

Analogous to text_color.

over_text_color

Same as above.

down_text_color

Same as above.

retro

Whether the images should be loaded with the ‘retro’ option set (see Gosu::Image for details). If the value is omitted, the Res.retro_images value will be used.

scale_x

Horizontal scale to draw the component with.

scale_y

Vertical scale to draw the component with.

on_changed

Action performed when the value of the dropdown is changed. It must be a block with two parameters, which will receive the old and the new value, respectively.

Obs.: This method accepts named parameters, but x, y, font and options are mandatory (also, img and opt_img are mandatory when width and height are not provided, and vice-versa).



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
 
# File 'lib/minigl/forms.rb', line 1101

def initialize(x, y = nil, font = nil, img = nil, opt_img = nil, options = nil,
               option = 0, text_margin = 0, width = nil, height = nil,
               text_color = 0, disabled_text_color = 0, over_text_color = 0, down_text_color = 0,
               retro = nil, scale_x = 1, scale_y = 1, &on_changed)
  if x.is_a? Hash
    y = x[:y]
    font = x[:font]
    img = x[:img]
    opt_img = x[:opt_img]
    options = x[:options]
    option = x.fetch(:option, 0)
    text_margin = x.fetch(:text_margin, 0)
    width = x.fetch(:width, nil)
    height = x.fetch(:height, nil)
    text_color = x.fetch(:text_color, 0)
    disabled_text_color = x.fetch(:disabled_text_color, 0)
    over_text_color = x.fetch(:over_text_color, 0)
    down_text_color = x.fetch(:down_text_color, 0)
    retro = x.fetch(:retro, nil)
    scale_x = x.fetch(:scale_x, 1)
    scale_y = x.fetch(:scale_y, 1)
    x = x[:x]
  end

  super x, y, font, options[option], text_color, disabled_text_color
  @img = img
  @opt_img = opt_img
  @options = options
  @value = @options[option]
  @open = false
  @buttons = []
  @buttons.push(
    Button.new(x, y, font, @value, img, text_color, disabled_text_color, over_text_color, down_text_color,
               false, true, text_margin, 0, width, height, nil, retro, scale_x, scale_y) {
                 toggle
               }
  )
  
  @scale_x = scale_x
  @scale_y = scale_y
  @w = @buttons[0].w
  @h = @buttons[0].h
  @max_h = (@options.size + 1) * @h

  @options.each_with_index do |o, i|
    b = Button.new(x, y + (i+1) * @h, font, o, opt_img, text_color, disabled_text_color, over_text_color, down_text_color,
                   false, true, text_margin, 0, width, height, nil, retro, scale_x, scale_y) {
                     old = @value
                     @value = @buttons[0].text = o
                     @on_changed.call(old, o) if @on_changed
                     toggle
                   }
    b.visible = false
    @buttons.push b
  end

  @on_changed = on_changed
end

Instance Attribute Details

#options ⇒ Object

An array containing all the options (each of them Strings) that can be selected in the drop-down list.



1067
1068
1069
 
# File 'lib/minigl/forms.rb', line 1067

def options
  @options
end

#value ⇒ Object

The selected value in the drop-down list. This is one of the options.



1063
1064
1065
 
# File 'lib/minigl/forms.rb', line 1063

def value
  @value
end

Instance Method Details

#draw(alpha = 0xff, z_index = 0, color = 0xffffff, over_color = 0xcccccc) ⇒ Object

Draws the drop-down list.

Parameters:

alpha

(Fixnum) The opacity with which the drop-down list will be drawn. Allowed values vary between 0 (fully transparent) and 255 (fully opaque).

z_index

(Fixnum) The z-order to draw the object. Objects with larger z-orders will be drawn on top of the ones with smaller z-orders.

color

Color of the buttons, if no image was provided, or color to apply a filter to the images.

over_color

Color of the buttons when the mouse is over them (when no image was provided).



1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
 
# File 'lib/minigl/forms.rb', line 1198

def draw(alpha = 0xff, z_index = 0, color = 0xffffff, over_color = 0xcccccc)
  return unless @visible
  unless @img
    bottom = @y + (@open ? @max_h : @h) + @scale_y
    b_color = (alpha << 24)
    G.window.draw_quad @x - @scale_x, @y - @scale_y, b_color,
                       @x + @w + @scale_x, @y - @scale_y, b_color,
                       @x + @w + @scale_x, bottom, b_color,
                       @x - @scale_x, bottom, b_color, z_index
    @buttons.each do |b|
      c = (alpha << 24) | (b.state == :over ? over_color : color)
      G.window.draw_quad b.x, b.y, c,
                         b.x + b.w, b.y, c,
                         b.x + b.w, b.y + b.h, c,
                         b.x, b.y + b.h, c, z_index if b.visible
    end
  end
  @buttons.each { |b| b.draw alpha, z_index, color }
end

#enabled=(value) ⇒ Object

:nodoc:



1180
1181
1182
1183
1184
 
# File 'lib/minigl/forms.rb', line 1180

def enabled=(value) # :nodoc:
  toggle if @open
  @buttons[0].enabled = value
  @enabled = value
end

#update ⇒ Object

Updates the control.



1161
1162
1163
1164
1165
1166
1167
1168
 
# File 'lib/minigl/forms.rb', line 1161

def update
  return unless @enabled and @visible
  if @open and Mouse.button_pressed? :left and not Mouse.over?(@x, @y, @w, @max_h)
    toggle
    return
  end
  @buttons.each { |b| b.update }
end