1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
</R>Purpose<!R>
The label widget allows a programmer to create a message box. This message box
can be part of the screen or a temporary pop up message box.
</R>Construction Options<!R>
A label widget is defined using the following syntax. The variable
</B>$labelObject<!B> contains the reference to the label object.
<C></B>$labelObject = new Cdk::Label ( options );
The options are defined in the following table.
</U>Option Default Value Type Purpose<!U>
Mesg Required Array Ref This is the contents of the message inside the window.
Xpos Center Scalar This is the position of the window on the X axis.
Ypos Center Scalar This is the position of the window on the Y axis.
Box True Scalar This Boolean states whether the dialog box will have a box drawn around it.
Shadow False Scalar This Boolean states whether the dialog box will have a shadow on the box.
</R>Available Methods<!R>
</B>draw<!B>
This method draws the object on the screen. The following example demonstrates
how to call the draw method.
<C></B>$labelObject->draw ( options );
The options are defined in the following table.
</U>Option Default Value Type Purpose<!U>
Box True Scalar Draws the window with a box around it.
</B>erase<!B>
This method removes the object from the screen. This does </B/U>NOT<!B!U>
destroy the object. The following example demonstrates how to call the erase
method.
<C></B>$labelObject->erase ();
</B>wait<!B>
This method freezes until a key has been hit. This allows the user to put a
message inside the label telling the user to hit any key when ready. The
following example demonstrates how to call the wait method.
<C></B>$labelObject->wait( options );
The options are defined in the following table.
</U>Option Default Value Type Purpose<!U>
Key NULL Scalar Tells the object which key to hit to exit the object.
</B>raise<!B>
The raise method raises the widget to the top of the screen. This means if there
were any widgets obscuring part of the view, raising the object would bring the
complete object into view. The following example demonstrates how to call the
raise method.
<C></B>$labelObject->raise();
</B>lower<!B>
The lower method lowers the object so it doesn't obscure the view of any other
objects. The following example demonstrates how to call the lower method.
<C></B>$labelObject->lower();
</B>register<!B>
The register method registers the object to the default screen. This does </R>NOT<!R>
have to be called since the objects are registered automatically. This method
should be called if the </B>unregister<!B> method was called. The following
example demonstrates how to call the register method.
<C></B>$labelObject->register();
</B>unregister<!B>
The unregister method should be called when a widget, which is part of the
default screen, needs to be taken away temporarily. This does not delete or free
the object, it just unmaps it from any future screen refreshes. The object can
be registered by calling the </B>register<!B> method. The following example
demonstrates how to call the unregister method.
<C></B>$labelObject->unregister();
</B>getwin<!B>
This method returns a pointer to the window of the object. Not much use for this
yet. It will be useful in the future when the drawing methods are added. The
following example demonstrates how to call the getwin method.
<C></B>$labelObject->getwin();
</R>Tips & Tricks<!R>
<B=*>A title can be added to the label widget by using the formatting commands available with Cdk.
</R>Physical Restrictions<!R>
</U>Restriction Value<!U>
Maximum Rows 300
</R>Example Use Of The Widget<!R>
<F=../examples/label>
<C><#HL(70)>
<C>Document Created: June, 1995
<C>Document Revised: November, 1995
<C>Document Revised: March, 1996
|
