Class Dialog

Superclasses :
gui::Component
Subclasses :
gui::FileDialog
Package :
gui

This is the parent class of a dialog window.

Source

Class summary
Methods inherited from gui::Component
accepts_focus() add(c, i) all_valid() can_drag(ev) can_drop(d) child_validated(c) clear_accepts_focus() clear_allow_drag() clear_allow_drop() clear_draw_border() clear_is_shaded() create_event_and_fire(type, param) do_handle_event(e) do_shading(W) drag_event(d) drag_reset() end_drag(d, c) fatal(s) finally() find_accel(e) find_focus() fire_icon_events_on_mouse(p, e) firstly() generate_components() get_accel() get_cbwin_reference() get_children() get_cwin_reference() get_h_reference() get_parent() get_parent_buffer_win() get_parent_dialog() get_parent_dialog_reference() get_parent_win() get_w_reference() get_x_reference() get_y_reference() got_focus(e) handle_accel(e) handle_event(e) in_region() invalidate() invoke_can_drag(ev) invoke_can_drop(d) invoke_drag_event(d) invoke_drag_reset() invoke_end_drag(d, c) is_attrib(s) is_dialog_open() is_ticking() keeps(e) lost_focus(e) parse_pos(total, s) remove(c) resize() retime_ticker(n) set_abs_coords(x, y) set_abs_size(w, h) set_accel(k) set_accepts_focus() set_align(x_align, y_align) set_allow_drag() set_allow_drop() set_attribs(x[]) set_attribs_list(l) set_draw_border() set_is_shaded() set_parent(c) set_parent_dialog(c) set_pos(x_spec, y_spec) set_size(w_spec, h_spec) set_ticker(n, d) set_tooltip(x) stop_ticker() tick() toggle_draw_border() toggle_is_shaded() unique_end(x) unique_start() validate()
Variables inherited from gui::Component
accel accepts_focus_flag allow_drag_flag allow_drop_flag attribs cbwin children cwin draw_border_flag h h_spec has_focus is_shaded_flag parent parent_dialog ticker tooltip valid w w_spec x x_align x_spec y y_align y_spec
Methods inherited from lang::Object
clone(seen) equals(other, seen) get_class() get_class_name() get_id() hash_code(depth, seen) is_instance(name) to_string(depth, seen)
Methods inherited from util::SetFields
as_attrib(attr, val) attrib(a[]) cset_val(attr, val) field_error(s) int_val(attr, val) int_vals(attr, val, n) numeric_val(attr, val) numeric_vals(attr, val, n) set_fields(l) string_val(attr, val) string_vals(attr, val, n) test_flag(attr, val)
Methods inherited from util::Connectable
connect(obj, meth, type) disconnect(l) fire(type, param) fire_event(e)
Variables inherited from util::Connectable
listeners
Methods defined in this class
bevel_dispose() block() change_pointer(s) check_click_count(e) check_dnd(e) clear_focus(e) clear_unique(x) close_win() component_setup() compute_absolutes() consume_same(e) display(buffer_flag) dispose() end_dialog() find_next_focus() find_previous_focus() get_buffer_win() get_click_count() get_focus_list() get_win() handle_resize(e) init() init_dialog() initially() invoke_validate() is_hidden() is_shaded() is_unhidden() is_unshaded() needs_validate() open_win() process_dnd(e) process_event(e) process_normal(e) process_unique(e) resize_win(w, h) restore_pointer() set_double_click_delay(i) set_focus(c, e) set_min_size(w, h) set_one(attr, val) set_repeat_delay(i) set_repeat_rate(i) set_unique(c) show() show_child(d) show_modal(d) show_modeless(d) unblock()
Variables defined in this class
all_valid buffer_win child_dialogs click_count curr_drag double_click_delay drag_gesture_x drag_gesture_y focus is_blocked_flag is_open min_height min_width owning_dialog pointer_stack prev_event prev_time prev_x prev_y re_process_flag repeat_delay repeat_rate resize_attrib tried_drag unique_flag win

Method detail

bevel_dispose()

Source

block()

Source

change_pointer(s)

Change pointer, saving current pointer on a stack for restoration.
Source

check_click_count(e)

Private method, not intended for client invocation

check_dnd(e)

Private method, not intended for client invocation

clear_focus(e)

Clear the keyboard focus.
Source

clear_unique(x)

Source

close_win()

Source

component_setup()

This empty method may be overridden to add components to the dialog. Alternatively, components may be added in the dialog's initially method.
Source

compute_absolutes()

Overrides compute_absolutes() in gui::Component
Source

consume_same(e)

Source

display(buffer_flag)

Overrides display(buffer_flag) in gui::Component
Private method, not intended for client invocation

dispose()

Source

end_dialog()

This empty method may be overridden. It is invoked just before the dialog window is closed.
Source

find_next_focus()

Source

find_previous_focus()

Source

get_buffer_win()

Source

get_click_count()

Returns the number of mouse clicks that have occurred consecutively, with each click in the sequence being less than double_click_delay milliseconds apart. That variable is by default 500 milliseconds, but it may be configured with set_double_click_delay().
Source

get_focus_list()

Source

get_win()

Returns the Icon window associated with the dialog.
Source

handle_resize(e)

Private method, not intended for client invocation

init()

Overrides init() in gui::Component
Source

init_dialog()

This empty method is invoked just after the dialog is displayed for the first time.
Source

initially()

Overrides initially() in util::Connectable

invoke_validate()

Source

is_hidden()

Overrides is_hidden() in gui::Component
Source

is_shaded()

Overrides is_shaded() in gui::Component
Source

is_unhidden()

Overrides is_unhidden() in gui::Component
Source

is_unshaded()

Overrides is_unshaded() in gui::Component
Source

needs_validate()

Source

open_win()

Source

process_dnd(e)

Private method, not intended for client invocation

process_event(e)

Source

process_normal(e)

Private method, not intended for client invocation

process_unique(e)

Private method, not intended for client invocation

resize_win(w, h)

Source

restore_pointer()

Restore pointer, from the stack of pointers.
Source

set_double_click_delay(i)

Set the delay in milliseconds between double clicks. The default is 500 milliseconds
Source

set_focus(c, e)

Sets keyboard focus to the given component. This method should only be invoked after the dialog has been displayed. To give a component the initial keyboard focus, invoke this method from within init_dialog()
Source

set_min_size(w, h)

Sets the minimum dimensions for a window. The user will not be able to resize the window below this size.
Source

set_one(attr, val)

Overrides set_one(attr, val) in util::SetFields
Source

set_repeat_delay(i)

Set the delay in milliseconds between an initial repeating event and the start of repeat events. The default is 500 milliseconds
Source

set_repeat_rate(i)

Set the delay in milliseconds between repeating events. The default is 100 milliseconds
Source

set_unique(c)

Source

show()

Source

show_child(d)

This is a variation on the conventional modal and modeless methods. The dialog is opened, input to other windows is not blocked, but the call does not return until the window is closed.
Parameters :
d - The parent dialog, if specified, is blocked until the window is closed.
Source

show_modal(d)

Displays the dialog as a modal dialog. In other words, window events to any other open dialogs are blocked until the dialog is closed. This method doesn't return until the dialog is closed.
Parameters :
d - The parent dialog. It will not normally be needed.
Source

show_modeless(d)

Displays the dialog as a modeless dialog. This means that window events are processed by this dialog and other open dialogs concurrently. The call to show_modeless() opens the dialog and returns immediately.
Parameters :
d - This optional parameter specifies the parent dialog. When a parent dialog is closed, its child dialogs are automatically closed.
Source

unblock()

Source

Variable detail

all_valid


buffer_win


child_dialogs


click_count


curr_drag


double_click_delay


drag_gesture_x


drag_gesture_y


focus


is_blocked_flag


is_open


min_height


min_width


owning_dialog


pointer_stack


prev_event


prev_time


prev_x


prev_y


re_process_flag


repeat_delay


repeat_rate


resize_attrib


tried_drag


unique_flag


win