Using Dialog Prompts (Advanced) - Revision history

Paulb at 18:19, 14 May 2008

2008-05-14T18:19:06Z

Paulb: /* Default Cancel Button */

2007-09-25T17:49:08Z

‎Default Cancel Button

Paulb: /* Default Confirm Button */

2007-09-25T17:48:45Z

‎Default Confirm Button

Paulb: /* Adding Graphical Elements */

2007-09-11T16:27:10Z

‎Adding Graphical Elements

Paulb: /* Changing Button Labels */

2007-09-11T16:26:43Z

‎Changing Button Labels

Paulb: /* Default Confirm Button */

2007-09-11T16:25:39Z

‎Default Confirm Button

Paulb: /* Setting Default Buttons */

2007-09-06T23:21:40Z

‎Setting Default Buttons

Paulb: /* Dialog Prompt Buttons */

2007-09-06T23:10:07Z

‎Dialog Prompt Buttons

Paulb: /* Extending Dialog Prompts */

2007-09-06T18:51:33Z

‎Extending Dialog Prompts

Paulb: /* Adding Buttons and Button Sets */

2007-09-06T18:51:03Z

‎Adding Buttons and Button Sets

← Older revision		Revision as of 18:19, 14 May 2008
Line 1:		Line 1:
	[[Category:Extending_EiffelStudio]]		[[Category:Extending_EiffelStudio]]
		+	[[Category:EiffelStudio Foundations]]

	There are two methods of displaying dialog prompts inside [[:Category:EiffelStudio\|EiffelStudio]]. Firstly there is the simple and effective approach, which requires very little coding but offers very little in the way of customization. The second approach can be simple, but by not means as simple as the first, and can offer a great deal of customization. The information in this page pertains for the latter approach. To use the former please see [[Using Dialog Prompts (Basic)]].		There are two methods of displaying dialog prompts inside [[:Category:EiffelStudio\|EiffelStudio]]. Firstly there is the simple and effective approach, which requires very little coding but offers very little in the way of customization. The second approach can be simple, but by not means as simple as the first, and can offer a great deal of customization. The information in this page pertains for the latter approach. To use the former please see [[Using Dialog Prompts (Basic)]].

@@ Line 112: / Line 112: @@
 ==== Default Cancel Button ====
-There also exists a default cancel button, which is selected when the user presses ESC or closes the dialog prompt without pressing one of the dialog prompt buttons. Like the [[#Default Active Button|default active button]], this behavior is inherited from [https://eiffelsoftware.origo.ethz.ch/svn/es/trunk/Src/Eiffel/interface/new_graphical/dialogs/es_dialog.e ES_DIALOG]. The cancel buttons should always be associated with the '''Cancel''' button, if it exists, or be associated with the least dangerous button on the prompt.
+There also exists a default cancel button, which is selected when the user presses {{key|ESC}} or closes the dialog prompt without pressing one of the dialog prompt buttons. Like the [[#Default Active Button|default active button]], this behavior is inherited from [https://eiffelsoftware.origo.ethz.ch/svn/es/trunk/Src/Eiffel/interface/new_graphical/dialogs/es_dialog.e ES_DIALOG]. The cancel buttons should always be associated with the '''Cancel''' button, if it exists, or be associated with the least dangerous button on the prompt.
 You can set the default cancel button just like you can the [[#Default Active Button|default active button]] and [[#Default Confirm Button|default confirm button]] using <eiffel>set_default_cancel_button</eiffel>:

@@ Line 88: / Line 88: @@
 ==== Default Confirm Button ====
-The default confirm button is another default button, but this setting for this button has no visible cue as the [[#Default Active Button|Default Active Button]] does. Instead the default confirm button is the button that is selected when the user opts to confirm a default action on the dialog using CTRL+ENTER, once the dialog prompt is show.
+The default confirm button is another default button, but this setting for this button has no visible cue as the [[#Default Active Button|Default Active Button]] does. Instead the default confirm button is the button that is selected when the user opts to confirm a default action on the dialog using {{Key|CTRL+ENTER}}, once the dialog prompt is show.
 The default confirm button can be set using <eiffel>set_default_confirm_button</eiffel>:

@@ Line 290: / Line 290: @@
 === Adding Graphical Elements ===
-Whether you are using [https://eiffelsoftware.origo.ethz.ch/svn/es/trunk/Src/Eiffel/interface/new_graphical/dialogs/prompts/es_prompt.e ES_PROMPT] or a common dialog prompt as your base implementation, you will need to redefine <eiffel>build_prompt_interface</eiffel> to add graphical widgets to the main dialog prompt's area (the area with a white background.) Be sure to call <eiffel>Precursor</eiffel> to ensure the dialog prompt's [[#Changing the Title, Subtitle and Text| subtitle and text] are displayed correctly.
+Whether you are using [https://eiffelsoftware.origo.ethz.ch/svn/es/trunk/Src/Eiffel/interface/new_graphical/dialogs/prompts/es_prompt.e ES_PROMPT] or a common dialog prompt as your base implementation, you will need to redefine <eiffel>build_prompt_interface</eiffel> to add graphical widgets to the main dialog prompt's area (the area with a white background.) Be sure to call <eiffel>Precursor</eiffel> to ensure the dialog prompt's [[#Changing the Title, Subtitle and Text| subtitle and text]] are displayed correctly.
 === Adding Buttons and Button Sets ===

@@ Line 226: / Line 226: @@
 Not only has the text been changed on the dialog prompt but the buttons have also been resized and both resized to match each width, as per the general user interface guidelines related to dialog buttons. This is just one of the new features of the new dialog implementation in [[EiffelStudio_6.1_Releases|6.1]].
-In addition the resizing the key bindings have also been altered. On regular question prompts with '''Yes''' and '''No''' buttons pressing the ''Y'' key will select the '''Yes''' button and pressing ''N'' will select the '''No''' button. With the buttons relabeled from their defaults new key bindings are introduced. '''Save Changes''' can be select by pressing ''S'' and '''Continue Without Save''' selected by pressing ''C''.
+In addition the resizing the key bindings have also been altered. On regular question prompts with '''Yes''' and '''No''' buttons pressing the {{key|Y}} key will select the '''Yes''' button and pressing {{key|N}} will select the '''No''' button. With the buttons relabeled from their defaults new key bindings are introduced. '''Save Changes''' can be select by pressing {{key|S}} and '''Continue Without Save''' selected by pressing {{key|C}}.
 == Changing the Title, Subtitle and Text ==

← Older revision		Revision as of 16:25, 11 September 2007
Line 107:		Line 107:


−	In the above code the [[#Default Active Button\|default active button]] is actually the '''No''' button but the default action button is the '''Yes''' button. Press CTRL+ENTER will selected '''Yes''', whereas pressing ENTER or SPACE will select the focused (active) button '''No'''.	+	In the above code the [[#Default Active Button\|default active button]] is actually the '''No''' button but the default action button is the '''Yes''' button. Press {{key\|CTRL+ENTER}} will selected '''Yes''', whereas pressing {{key\|ENTER}} or {{key\|SPACE}} will select the focused (active) button '''No'''.

	{{Note\| The functionality whereby the user can press CTRL+ENTER, is inherited behavior from top most inherited class [https://eiffelsoftware.origo.ethz.ch/svn/es/trunk/Src/Eiffel/interface/new_graphical/dialogs/es_dialog.e ES_DIALOG].}}		{{Note\| The functionality whereby the user can press CTRL+ENTER, is inherited behavior from top most inherited class [https://eiffelsoftware.origo.ethz.ch/svn/es/trunk/Src/Eiffel/interface/new_graphical/dialogs/es_dialog.e ES_DIALOG].}}

@@ Line 87: / Line 87: @@
 [[Image:Dialog prompts example question default.png|Yes is now the default button]]
-The default button is activated by pressing ENTER or SPACE when the dialog prompt is shown. It is also selected when the user presses CTRL+ENTER, which is inherited behavior from top most inherited class [https://eiffelsoftware.origo.ethz.ch/svn/es/trunk/Src/Eiffel/interface/new_graphical/dialogs/es_dialog.e ES_DIALOG].
+The default confirm button can be set using <eiffel>set_default_confirm_button</eiffel>:
 ==== Default Cancel Button ====
-There also exists a default cancel button, which is activated when the user presses ESC or closes the dialog prompt without pressing one of the dialog prompt buttons. Like the default button, this behavior is inherited from [https://eiffelsoftware.origo.ethz.ch/svn/es/trunk/Src/Eiffel/interface/new_graphical/dialogs/es_dialog.e ES_DIALOG]. The default cancel button is actually automatically determined for all prompts using [https://eiffelsoftware.origo.ethz.ch/svn/es/trunk/Src/Eiffel/interface/new_graphical/dialogs/es_dialog_buttons.e ES_DIALOG_BUTTONS].<eiffel>default_cancel_buttons</eiffel>, which is also used to set the default button for all dialog prompts (remember, least dangerous action rule?)
+There also exists a default cancel button, which is selected when the user presses ESC or closes the dialog prompt without pressing one of the dialog prompt buttons. Like the [[#Default Active Button|default active button]], this behavior is inherited from [https://eiffelsoftware.origo.ethz.ch/svn/es/trunk/Src/Eiffel/interface/new_graphical/dialogs/es_dialog.e ES_DIALOG]. The cancel buttons should always be associated with the '''Cancel''' button, if it exists, or be associated with the least dangerous button on the prompt.
-You can set the default cancel button just like you can the default button, however setting the default cancel button will not affect the default button even if you have not set the default button. To set the default cancel button use the routine <eiffel>set_default_cancel_button</eiffel>, specifying a button identifier of a button that exists on the dialog prompt. The code below shows how this is done.
+You can set the default cancel button just like you can the [[#Default Active Button|default active button]] and [[#Default Confirm Button|default confirm button]] using <eiffel>set_default_cancel_button</eiffel>:
 <eiffel>
@@ Line 102: / Line 123: @@
    do
      create l_prompt.make_standard ("Save changes before continuing?")
      l_prompt.set_default_cancel_button ({ES_DIALOG_BUTTONS}.no_button)
      l_prompt.show_on_active_window

@@ Line 40: / Line 40: @@
 * Information: '''Ok'''|'''Cancel'''
 * Question: '''Yes'''|'''No'''|'''Cancel'''
 === Button Sets ===

← Older revision		Revision as of 18:51, 6 September 2007
Line 264:		Line 264:

	All dialog prompts are fully extendable. You may either use an existing dialog prompt as your base implementation or you can use [https://eiffelsoftware.origo.ethz.ch/svn/es/trunk/Src/Eiffel/interface/new_graphical/dialogs/prompts/es_prompt.e ES_PROMPT], although using [https://eiffelsoftware.origo.ethz.ch/svn/es/trunk/Src/Eiffel/interface/new_graphical/dialogs/prompts/es_prompt.e ES_PROMPT] requires a little more (simple) implementation.		All dialog prompts are fully extendable. You may either use an existing dialog prompt as your base implementation or you can use [https://eiffelsoftware.origo.ethz.ch/svn/es/trunk/Src/Eiffel/interface/new_graphical/dialogs/prompts/es_prompt.e ES_PROMPT], although using [https://eiffelsoftware.origo.ethz.ch/svn/es/trunk/Src/Eiffel/interface/new_graphical/dialogs/prompts/es_prompt.e ES_PROMPT] requires a little more (simple) implementation.
		+
		+	If you are implementing a common dialog prompt you can simply examining the existing common dialog implementation for guides. See [https://eiffelsoftware.origo.ethz.ch/svn/es/trunk/Src/Eiffel/interface/new_graphical/dialogs/prompts/es_question_prompt.e ES_QUESTION_PROMPT] for an example on implement a common dialog prompt.

	=== Adding Graphical Elements ===		=== Adding Graphical Elements ===

@@ Line 270: / Line 270: @@
 === Adding Buttons and Button Sets ===
-Changing the buttons, beyond changing their labels is a little more involved. Please see [[Dialog Button Sets]] for information about adding your own buttons sets and button identifiers. Also, if you are implementing your own common dialog prompt you can simply examining the existing common dialog implementation for guides. See [https://eiffelsoftware.origo.ethz.ch/svn/es/trunk/Src/Eiffel/interface/new_graphical/dialogs/prompts/es_question_prompt.e ES_QUESTION_PROMPT] for an example on implement a common dialog prompt.
+Changing the buttons, beyond changing their labels is a little more involved. Please see [[Dialog Button Sets]] for information about adding your own buttons sets and button identifiers.
 If you do decided to extend [https://eiffelsoftware.origo.ethz.ch/svn/es/trunk/Src/Eiffel/interface/new_graphical/dialogs/es_dialog_buttons.e ES_DIALOG_BUTTONS] for a specialize dialog prompt, please remember to convariantly redefine <eiffel>dialog_buttons</eiffel> to return an shared instances of your extended version of [https://eiffelsoftware.origo.ethz.ch/svn/es/trunk/Src/Eiffel/interface/new_graphical/dialogs/es_dialog_buttons.e ES_DIALOG_BUTTONS]. This will given dialog prompt clients access to new button identifiers and button sets.
 In addition to creating new button identifiers and button sets it is required to redefine <eiffel>dialog_button_label</eiffel> from [https://eiffelsoftware.origo.ethz.ch/svn/es/trunk/Src/Eiffel/interface/new_graphical/dialogs/prompts/es_prompt.e ES_PROMPT]. You implementation should respect the new button identifiers and return a default localized button label.