Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

Name

qwarning — information dialog displaying a warning

Syntax

Panel
bgColor#FFFFAA
borderWidth1
borderStylesolid

qwarning caption text [button-0-text

_

]

\

[

_

button-1-text

_

]

\

[

_

button-2-text

_] {panel} h2. Description The *qwarning* command displays a

]

Description

The qwarning command displays a read-only

...

warning

...

dialog

...

with

...

one

...

or

...

more

...

buttons,

...

along

...

with

...

a

...

caption.

...

The

...

default

...

is

...

a

...

single

...

'OK'

...

button.

...

The

...

dialog

...

is

...

modal

...

,

...

therefore

...

execution

...

is

...

halted

...

until

...

the

...

user

...

closes

...

the

...

dialog.

...

The

...

dialog

...

may

...

optionally

...

have

...

up

...

to

...

three

...

buttons

...

to

...

replace

...

the

...

default

...

OK

...

button.

...

The

...

buttons

...

are

...

implicitly

...

numbered

...

0,

...

1,

...

2.

...

The

...

command

...

will

...

return

...

the

...

number

...

corresponding

...

to

...

the

...

button

...

pressed

...

by

...

the

...

user.

...

Arguments

caption

Dialog title.

text

The main text of the dialog

button-x-text

...

Text

...

to

...

appear

...

on

...

button

...

number

...

x.

...

There

...

may

...

be

...

1,

...

2,

...

or

...

3

...

buttons

...

provided

...

in

...

place

...

of

...

the

...

default OK button.

Examples

Ex.1:

...

Warning

...

dialog

...

Anchor
Warning dialog
Warning dialog

No Format
bgColor#eeeeee
borderWidth1
# A titled dialog with a message and OK button
qwarning Warning "This is a warning"

{noformat}

!att:_img_cmd^qwarning.png!

The above example shows the simplest use of *qwarning*. The *OK* button is created automatically.

h3. 

Image Added

The above example shows the simplest use of qwarning. The OK button is created automatically.

Ex.2:

...

Information

...

dialog

...

with

...

extra

...

buttons

...

Anchor
Information dialog with extra buttons
Information dialog with extra buttons

No Format
bgColor#eeeeee
borderWidth1
# Warning with title and buttons. 
# Returns 0 (OK), 1 (Cancel), 2 (Details)
set button [qwarning "Open File" "Failed to open file" OK Cancel Details]
if { $button == 0 } {
	# OK button was pressed
} elseif { $button == 1 } {
	# Cancel buttons was pressed
} elseif { $button == 2 } {
	# Details buttons was pressed
}

{noformat}

!att:_img_cmd^qwarning_buttons.png!

Example +Information dialog with extra buttons+ shows a warning dialog with a title and extra buttons. The number 0, 1, or 2 is returned to the program, depending on which button the user clicks. 


{pagebreak}

Image Added

Example Information dialog with extra buttons shows a warning dialog with a title and extra buttons. The number 0, 1, or 2 is returned to the program, depending on which button the user clicks.