Common Desktop Environment: Style Guide and Certification Checklist

Dialog Box Design


Note -

These requirements apply only in a left-to-right language environment in an English-language locale. You must make the appropriate changes for other locales.


 

n/a 

 

 

Recommended 

cp: 

The title of dialog boxes used within your application adheres to the conventions listed in Table 10-3

.

Table 10-3 Dialog Box Title Conventions

Window Usage 

Window Title Format 

Message 

<app or object name> : <action or situation> 

Progress 

<app or object name> : <action> in Progress 

Action (Command) 

<app name> : <action> 

Object Properties 

<app name> : <object-type> Properties 

Application Options 

<app name> : <type> Options 

 

n/a 

 

 

 

Required 

cq: 

Every dialog box in your application has at least one button that either performs the dialog box action and dismisses it or dismisses the dialog box without taking any action. 

Recommended 

cr: 

If your application uses common dialog box actions, the actions have the following specified functionality and labels: 

Optional 

 

Yes 

Indicates an affirmative response to a question posed in the dialog box. 

Optional 

 

No 

Indicates a negative response to a question posed in the dialog box. 

Optional 

 

OK 

Applies any changes made to components in the dialog box and dismisses the dialog box. 

Optional 

 

<command> 

Applies any changes made to components in the dialog box, performs the action associated with the <command>, and dismisses the dialog box. 

Should be used in lieu of OK, Yes, or No as a button label when it provides more meaning to the user as to the action that will be performed when that button is clicked. 

Optional 

 

Apply 

Applies any changes made to components in the dialog box and does not dismiss it. 

Optional 

 

Retry 

Causes the task in progress to be attempted again. 

Optional 

 

Stop 

Ends the task in progress at the next possible break point. 

Optional 

 

Pause 

Causes the task in progress to pause. 

Optional 

 

Resume 

Causes a task that has paused to resume. 

Optional 

 

Save As Defaults 

Saves the current settings as the default settings that will appear the next time the window is displayed. The settings are not applied to any selected object and the dialog box is not dismissed. 

A Save As Defaults button should be provided if it is expected that a user would want to use different default values for a set of controls within a dialog box than those that you provide as the factory settings. For example, a Save As Defaults button might be provided in a "New <object-type>" window, allowing the user to indicate that whenever a new instance of that object-type is created, the current values should be displayed as the default settings instead of the values given by the application. 

Optional 

 

Reset 

Cancels any changes that have not yet been applied by your application. The controls within the dialog box are reset to their state since the last time the dialog box action was applied. If no changes have been applied within the current invocation of the dialog box, the controls are reset to the state when the dialog box was first displayed. 

Optional 

 

Reset to Factory 

Cancels any changes that have not yet been applied. Components in the dialog box are reset to their default state and value as specified by the vendor that delivered the application (that is, the controls are restored to the original factory settings). 

Optional 

 

Cancel 

Dismisses the dialog box without performing any actions not yet applied. 

Recommended 

 

Help 

Provides help for the dialog box. 

Recommended 

cs: 

Any visible control that is not currently active or whose setting is currently invalid is dimmed. 

Dimmed controls cannot be activated by the user and should appear only when the inactive state is short-term (that is, there is something the user can do within the application or the desktop environment to make the control become active). When the control is persistently inactive (because of the current configuration of the application or system, or a particular set of companion software is not currently installed), the control should be removed rather than dimmed. 

Optional 

ct: 

Keep the size of your dialog boxes to a minimum. Remember that on low-resolution displays, dialogs may take up most of the screen real estate, and may even run off the edge of the screen if not designed correctly. 

Optional 

cu: 

Avoid complexity in your dialog boxes. If your dialog box must support many functions, consider using an expandable dialog box (see "Expandable Windows"), or use more than one dialog in a nested fashion.

Optional 

cv: 

Avoid the use of resize handles in your dialog box. However, you may use resize handles when resizing is useful in allowing users to see more information; for example, when your dialog contains a scrolling list that is likely to be quite long, and users will frequently need to search the list. 

Optional 

cw: 

Every dialog box in your application has exactly one default button that is activated when the Return key is pressed. 

The default button should be associated with the most likely response from the user and should not be potentially destructive or irreversible. Some applications may have dialog boxes that do not reveal a default button until a specific set of fields has been filled out or otherwise manipulated. 

Optional 

cx: 

If a dialog box displayed by your application has controls that are considered to be advanced features, use an expandable dialog box, or use a multiple page dialog box that provides a <category> option menu that allows a user to navigate to each page.  

Controls that relate to advanced features should not be displayed with the set of options initially displayed to the user. The typical user should be presented with only those options that are necessary to use the basic functionality of the application. Users looking to access advanced functionality within the dialog box may use the <Category> option button (see Figure 7-1). If the number of advanced controls is few, or the settings for these controls are highly related to the settings of basic controls displayed in the dialog box (that is, the settings of the advanced controls change when the user changes settings for basic controls), you might choose to provide an expandable dialog box (see the section on Expandable Windows and Dialog Boxes). 

Property Windows

 

n/a 

 

 

 

Required 

cy: 

If your application provides settings that control the behavior of the application, these settings are displayed in an application properties window that is accessible from an Options menu. 

Recommended 

cz: 

If your application manages objects and allows the user to see or modify settings for these objects, these settings are displayed in an object properties window that is accessible from a Properties ... choice in the Edit, <object-type>, or Selected menus, as well as from the pop-up menu associated with the object. 

Recommended 

da: 

If your application provides access to a Properties or Options window, this window includes the following set of buttons in the order listed, with the specified functionality, when supported by your application. 

Required 

 

OK 

Applies any changes made to components in the dialog box and dismisses it. OK may be replaced by a more appropriate label; for example, Add. The alternate label should be a verb phrase. 

Optional 

 

Apply 

Applies any changes made to components in the dialog box and does not dismiss it. 

Required 

 

Reset 

Cancels any changes that have not yet been applied by your application. The controls within the dialog box are reset to their state since the last time the dialog box action was applied. If no changes have been applied within the current invocation of the dialog box, the controls are reset to the state when the dialog box was first displayed. 

Optional 

 

Reset to Factory 

Cancels any changes that have not yet been applied. Components in the dialog box are reset to their default state or value as specified by the vendor that delivered the application (that is, the controls are restored to the original factory settings). 

Required 

 

Cancel 

Dismisses the dialog box without performing any actions not yet applied. 

Required 

 

Help 

Provides help for the dialog box. 

Recommended 

db: 

If your application provides a Properties window that displays settings for a selected object, the Properties window tracks the current selection and modifies the state of any controls to accurately reflect the properties of the currently selected object.