Class _Dialog

Summary

#

  This is the parent class of a dialog window.

Superclasses:
Container

Package:
(main)
File:
gui.icn
Methods:
Close, Open, block, clear_focus, clear_unique, component_setup, dialog_event, display, dispose, end_dialog, get_buffer_win, get_cbwin_reference, get_click_count, get_cwin_reference, get_h_reference, get_visible_reference, get_w_reference, get_win, get_x_reference, get_y_reference, handle_notify, init_dialog, is_hidden, is_shaded, is_unhidden, is_unshaded, process_event, resize_win, set_double_click_delay, set_focus, set_min_size, set_repeat_delay, set_repeat_rate, set_unique, show, show_child, show_modal, show_modeless, unblock

Methods inherited from Component:
accepts_tab_focus, attrib, clear_accepts_tab_focus, clear_draw_border, clear_is_shaded, clear_no_updates, do_shading, error, get_parent_Dialog, get_parent_buffer_win, get_parent_win, got_focus, lost_focus, parse_pos, redisplay, set_abs_coords, set_abs_size, set_accepts_tab_focus, set_align, set_attribs, set_attribs_list, set_draw_border, set_is_shaded, set_no_updates, set_parent_Dialog, set_pos, set_size, set_tooltip, toggle_draw_border, toggle_is_shaded, unique_end, unique_start

Methods inherited from Container:
add, final_setup, finally, firstly, generate_all_components, generate_components, get_components, handle_event, in_region, resize, set_components

Methods inherited from MetaComponent:
set_fields

Methods inherited from Ticker:
is_ticking, retime_ticker, set_ticker, stop_ticker, tick

Fields:
buffer_win, child_dialogs, click_count, double_click_delay, focus, is_blocked_flag, is_open, min_height, min_width, owning_dialog, prev_event, prev_time, prev_x, prev_y, re_process_flag, repeat_delay, repeat_rate, resize_attrib, unique_flag, win

Source code.

Details
Constructor

_Dialog(win, is_open, owning_dialog, child_dialogs, focus, unique_flag, re_process_flag, buffer_win, min_width, min_height, click_count, double_click_delay, repeat_delay, repeat_rate, prev_x, prev_y, prev_time, prev_event, is_blocked_flag, resize_attrib)

Parameters:
win
The dialog's window.
is_open
Flag indicates whether window is open
owning_dialog
child_dialogs
focus
Component with current focus
unique_flag
Flag indicates whether in unique processing mode
re_process_flag
Flag indicates whether to distribute last Icon event during unique mode
buffer_win
Buffer window for double buffering
min_width
Minimum size of window.
min_height
click_count
Variables controlling multiple clicks
double_click_delay
repeat_delay
Repeat event delays
repeat_rate
prev_x
prev_y
prev_time
prev_event
is_blocked_flag
resize_attrib

Methods:

Close()


Open()


block()


clear_focus()

#
  Clear the keyboard focus.


clear_unique(x)


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.


dialog_event(e)

#
  This method must be over-ridden in the subclass.  It is the
  method which is invoked when an event occurs.
  @param e   The instance of the {_Event} class to be processed.


display(buffer_flag)


 Display all components

This method overrides display in class Container

dispose(was_closed)


end_dialog()

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


get_buffer_win()


get_cbwin_reference()

This method overrides get_cbwin_reference in class Container

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().}


get_cwin_reference()

This method overrides get_cwin_reference in class Container

get_h_reference()

This method overrides get_h_reference in class Container

get_visible_reference()

This method overrides get_visible_reference in class Container

get_w_reference()

This method overrides get_w_reference in class Container

get_win()

#
  Returns the Icon window associated with the dialog.


get_x_reference()

This method overrides get_x_reference in class Container

get_y_reference()

This method overrides get_y_reference in class Container

handle_notify(e)

This method overrides handle_notify in class Component

init_dialog()


is_hidden()

This method overrides is_hidden in class Component

is_shaded()

This method overrides is_shaded in class Component

is_unhidden()

This method overrides is_unhidden in class Component

is_unshaded()

This method overrides is_unshaded in class Component

process_event(e)


resize_win(w, h)


set_double_click_delay(i)

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


set_focus(c)

#
  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()}


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.


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


set_repeat_rate(i)

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


set_unique(c)


show()


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.
  @param d   The parent dialog, if specified, is blocked until
  @ the window is closed.


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.
  @param d   The parent dialog.  It will not normally be
  @ needed.


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.

  @param d   This optional parameter specifies the parent dialog.
  @ When a parent dialog is closed, its child dialogs are automatically closed.


unblock()


Fields:
buffer_win -- Buffer window for double buffering

child_dialogs

click_count -- Variables controlling multiple clicks

double_click_delay

focus -- Component with current focus

is_blocked_flag

is_open -- Flag indicates whether window is open

min_height --

min_width -- Minimum size of window.

owning_dialog

prev_event

prev_time

prev_x

prev_y

re_process_flag -- Flag indicates whether to distribute last Icon event during unique mode

repeat_delay -- Repeat event delays

repeat_rate

resize_attrib

unique_flag -- Flag indicates whether in unique processing mode

win -- The dialog's window.


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