aboutsummaryrefslogtreecommitdiffstats
path: root/lib/gs/doc/src/gs_chapter1.xml
blob: 65e0ee208a566f8405da36610332b42455e3cee0 (plain) (blame)
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
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE chapter SYSTEM "chapter.dtd">

<chapter>
  <header>
    <copyright>
      <year>2000</year><year>2016</year>
      <holder>Ericsson AB. All Rights Reserved.</holder>
    </copyright>
    <legalnotice>
      Licensed under the Apache License, Version 2.0 (the "License");
      you may not use this file except in compliance with the License.
      You may obtain a copy of the License at
 
          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.
    
    </legalnotice>

    <title>GS - The Graphics System</title>
    <prepared></prepared>
    <docno></docno>
    <date></date>
    <rev></rev>
    <file>gs_chapter1.xml</file>
  </header>

  <section>
    <title>Introduction</title>
    <warning>
      <p>
	GS is not recommended for use in new applications.
	Instead we recommend WX for applications that need a
	graphical user interface.
      </p>
      <p>
	GS is not maintained and we plan to deprecate and remove it from
	the distribution as soon as possible, maybe already in the next
	major release (R15).
      </p>
    </warning>
    <p>This section describes the general graphics interface to Erlang. This system was designed with the following requirements in mind:</p>
    <list type="bulleted">
      <item>a graphics system which is easy to learn</item>
      <item>a graphics system which is portable to many different platforms.</item>
    </list>
    <p>Erlang has been implemented on a wide range of platforms and the graphics system works on all these platforms. Erlang applications can be written towards the same graphics API and the application can run on all supported platforms without modification.</p>
    <marker id="gs_fig1"/>
    <image file="images/gs1-1-image-1.gif">
      <icaption>Graphics Interface for Erlang</icaption>
    </image>
  </section>

  <section>
    <title>Basic Architecture of GS</title>
    <p>The basic building block in the graphics system is the graphical object. Objects are created in a hierarchical fashion where each object has a parent. The most common object types are:</p>
    <list type="bulleted">
      <item>window</item>
      <item>button</item>
      <item>label</item>
      <item>list box</item>
      <item>frame.</item>
    </list>
    <p>Whenever a new object is created, a unique object identifier is returned. This object identifier makes it possible to configure the object by changing its appearance and behaviour. This configuration of the object is controlled by the <em>Options</em>, also known as attributes or properties. These include width and height. Most options have a value of a specified type, but not all.</p>
    <p>Whenever an Erlang process creates a graphical object, it is said 
      to own the object. The graphics system must keep track of the owner 
      of every graphical object in order to forward incoming events to 
      the owner-process and kill the appropriate graphics window if the owner 
      process suddenly dies.</p>
    <marker id="gs_fig2"/>
    <image file="images/gs1-1-image-2.gif">
      <icaption>Owner Process</icaption>
    </image>
    <p>Events are messages which are sent from the graphical object to the owner-process. The events the owner-process is informed about may include:</p>
    <list type="bulleted">
      <item>the user has clicked on a button</item>
      <item>the user has entered text into an entry field</item>
      <item>the user has taken some action on the object, like moving the window.</item>
    </list>
    <marker id="gs_fig3"/>
    <image file="images/gs1-1-image-3.gif">
      <icaption>Events Delivered to Owner Process</icaption>
    </image>
  </section>
</chapter>