Blame platform-demos/ca/03_getting_the_signal.js.page

Packit 1470ea
Packit 1470ea
<page xmlns="http://projectmallard.org/1.0/" xmlns:its="http://www.w3.org/2005/11/its" xmlns:xi="http://www.w3.org/2001/XInclude" type="topic" style="task" id="03_getting_the_signal.js" xml:lang="ca">
Packit 1470ea
  <info>
Packit 1470ea
    <link type="guide" xref="beginner.js#tutorials"/>
Packit 1470ea
    <link type="seealso" xref="button.js"/>
Packit 1470ea
    <link type="seealso" xref="entry.js"/>
Packit 1470ea
    <link type="seealso" xref="radiobutton.js"/>
Packit 1470ea
    <link type="seealso" xref="switch.js"/>
Packit 1470ea
    <revision version="0.1" date="2012-08-12" status="draft"/>
Packit 1470ea
Packit 1470ea
    <credit type="author copyright">
Packit 1470ea
      <name>Taryn Fox</name>
Packit 1470ea
      <email its:translate="no">jewelfox@fursona.net</email>
Packit 1470ea
      <years>2012</years>
Packit 1470ea
    </credit>
Packit 1470ea
Packit 1470ea
    <desc>Create Buttons and other widgets that do things when you click on them.</desc>
Packit 1470ea
  </info>
Packit 1470ea
Packit 1470ea
  <title>3. Getting the Signal</title>
Packit 1470ea
  <synopsis>
Packit 1470ea
    

In the last tutorial, we learned how to create widgets like Labels, Images, and Buttons. Here, we'll learn how to make Buttons and other input widgets actually do things, by writing functions which handle the signals they send when they are clicked on or interacted with.

Packit 1470ea
  </synopsis>
Packit 1470ea
Packit 1470ea
  <links type="section"/>
Packit 1470ea
Packit 1470ea
  <section id="application">
Packit 1470ea
    <title>A basic application</title>
Packit 1470ea
    

In GNOME, widgets that you can interact with, like Buttons and Switches, send out signals when they are clicked on or activated. A Button, for instance, sends out the "clicked" signal when somebody clicks on it. When this happens, GNOME looks for the part in your code that says what to do.

Packit 1470ea
    

How do we write that code? By connecting that Button's "clicked" signal to a callback function, which is a function you write just to handle that signal. So whenever it gives off that signal, the function connected to that signal is run.

Packit 1470ea
    

Here is an extremely basic example:

Packit 1470ea
Packit 1470ea
    <media type="image" mime="image/png" src="media/03_jssignal_01.png"/>
Packit 1470ea
Packit 1470ea
    

This ApplicationWindow has a Button and a Label inside it, arranged in a Grid. Whenever the Button is clicked, a variable that holds the number of cookies is increased by 1, and the Label that shows how many cookies there are is updated.

Packit 1470ea
    <note style="tip">

The cookies in this example are not the same as the cookies that you get from websites, which store your login information and may keep track of which sites you've visited. They're just imaginary treats. You may bake some real ones if you like.

</note>
Packit 1470ea
    

Here is the basic, boilerplate code that goes at the start of the application, before we start creating the window and widgets. Besides the application having a unique name, the biggest change from the usual boilerplate is that we create a global variable right near the beginning, to hold the number of cookies.

Packit 1470ea
    
Packit 1470ea
#!/usr/bin/gjs
Packit 1470ea
Packit 1470ea
imports.gi.versions.Gtk = '3.0';
Packit 1470ea
const Gtk = imports.gi.Gtk;
Packit 1470ea
Packit 1470ea
// We start out with 0 cookies
Packit 1470ea
var cookies = 0;
Packit 1470ea
Packit 1470ea
class GettingTheSignal {
Packit 1470ea
    // Create the application itself
Packit 1470ea
    constructor() {
Packit 1470ea
        this.application = new Gtk.Application();
Packit 1470ea
Packit 1470ea
        // Connect 'activate' and 'startup' signals to the callback functions
Packit 1470ea
        this.application.connect('activate', this._onActivate.bind(this));
Packit 1470ea
        this.application.connect('startup', this._onStartup.bind(this));
Packit 1470ea
    }
Packit 1470ea
Packit 1470ea
    // Callback function for 'activate' signal presents window when active
Packit 1470ea
    _onActivate() {
Packit 1470ea
        this._window.present();
Packit 1470ea
    }
Packit 1470ea
Packit 1470ea
    // Callback function for 'startup' signal builds the UI
Packit 1470ea
    _onStartup() {
Packit 1470ea
        this._buildUI ();
Packit 1470ea
    }
Packit 1470ea
]]>
Packit 1470ea
    

Take a look at the part that uses our application's connect method and bind, to connect its activate and startup signals to the functions that present the window and build the UI. We're going to do the same thing with our Button when we get to it, except that we're going to connect its "clicked" signal instead.

Packit 1470ea
  </section>
Packit 1470ea
Packit 1470ea
  <section id="button">
Packit 1470ea
    <title>Click the button</title>
Packit 1470ea
Packit 1470ea
    

As usual, we'll put all the code to create our Button and other widgets inside the _buildUI function, which is called when the application starts up.

Packit 1470ea
    
Packit 1470ea
    // Build the application's UI
Packit 1470ea
    _buildUI() {
Packit 1470ea
]]>
Packit 1470ea
Packit 1470ea
    

First, we create the window itself:

Packit 1470ea
    
Packit 1470ea
        // Create the application window
Packit 1470ea
        this._window = new Gtk.ApplicationWindow({
Packit 1470ea
            application: this.application,
Packit 1470ea
            window_position: Gtk.WindowPosition.CENTER,
Packit 1470ea
            default_height: 200,
Packit 1470ea
            default_width: 400,
Packit 1470ea
            title: "Click the button to get a cookie!"});
Packit 1470ea
]]>
Packit 1470ea
    

Note that we've set its default_height and default_width properties. These let us control how tall and wide the ApplicationWindow will be, in pixels.

Packit 1470ea
    

Next, we'll create the Label that shows us the number of cookies. We can use the cookies variable as part of the Label's label property.

Packit 1470ea
    
Packit 1470ea
        // Create the label
Packit 1470ea
        this._cookieLabel = new Gtk.Label ({
Packit 1470ea
            label: "Number of cookies: " + cookies });
Packit 1470ea
]]>
Packit 1470ea
Packit 1470ea
    

Now we'll create the Button. We set its label property to show the text that we want on the Button, and we connect its "clicked" signal to a function called _getACookie, which we'll write after we're done building our application's UI.

Packit 1470ea
    
Packit 1470ea
        // Create the cookie button
Packit 1470ea
        this._cookieButton = new Gtk.Button ({ label: "Get a cookie" });
Packit 1470ea
Packit 1470ea
        // Connect the cookie button to the function that handles clicking it
Packit 1470ea
        this._cookieButton.connect ('clicked', this._getACookie.bind(this));
Packit 1470ea
]]>
Packit 1470ea
    

Finally, we create a Grid, attach the Label and Button to it, add it to the window and tell the window to show itself and its contents. That's all we need inside the _buildUI function, so we close it with a bracket, as well as a comma that tells GNOME to go on to the next function. Note that even though we wrote the code for the Label first, we can still attach it to the Grid in a way that will put it on the bottom.

Packit 1470ea
    
Packit 1470ea
        // Create a grid to arrange everything inside
Packit 1470ea
        this._grid = new Gtk.Grid ({
Packit 1470ea
            halign: Gtk.Align.CENTER,
Packit 1470ea
            valign: Gtk.Align.CENTER,
Packit 1470ea
            row_spacing: 20 });
Packit 1470ea
Packit 1470ea
        // Put everything inside the grid
Packit 1470ea
        this._grid.attach (this._cookieButton, 0, 0, 1, 1);
Packit 1470ea
        this._grid.attach (this._cookieLabel, 0, 1, 1, 1);
Packit 1470ea
Packit 1470ea
        // Add the grid to the window
Packit 1470ea
        this._window.add (this._grid);
Packit 1470ea
Packit 1470ea
        // Show the window and all child widgets
Packit 1470ea
        this._window.show_all();
Packit 1470ea
Packit 1470ea
    }
Packit 1470ea
]]>
Packit 1470ea
    

Now, we write the _getACookie function. Whenever our Button sends out its "clicked" signal, the code in this function will run. In this case, all it does is increase the number of cookies by 1, and update the Label to show the new number of cookies. We do this using the Label's set_label method.

Packit 1470ea
    <note style="tip">

Many widgets have the same properties and methods. Both Labels and Buttons, for instance, have a label property that says what text is inside them, and get_label and set_label methods that let you check what that text is and change it, respectively. So if you learn how one widget works, you'll also know how others like it work.

</note>
Packit 1470ea
    
Packit 1470ea
    _getACookie: function() {
Packit 1470ea
Packit 1470ea
        // Increase the number of cookies by 1 and update the label
Packit 1470ea
        cookies++;
Packit 1470ea
        this._cookieLabel.set_label ("Number of cookies: " + cookies);
Packit 1470ea
Packit 1470ea
    }
Packit 1470ea
Packit 1470ea
};
Packit 1470ea
]]>
Packit 1470ea
Packit 1470ea
    

Finally, we run the application, using the same kind of code as in our last tutorial.

Packit 1470ea
    
Packit 1470ea
// Run the application
Packit 1470ea
let app = new GettingTheSignal ();
Packit 1470ea
app.application.run (ARGV);
Packit 1470ea
]]>
Packit 1470ea
  </section>
Packit 1470ea
Packit 1470ea
  <section id="switch">
Packit 1470ea
    <title>Flip the switch</title>
Packit 1470ea
    

Buttons aren't the only input widgets in our GTK+ toolbox. We can also use switches, like the one in this example. Switches don't have a label property, so we have to create a separate Label that says what it does to go next to it.

Packit 1470ea
Packit 1470ea
    <media type="image" mime="image/png" src="media/03_jssignal_02.png"/>
Packit 1470ea
Packit 1470ea
    

A Switch has two positions, Off and On. When a Switch is turned on, its text and background color change, so you can tell which position it's in.

Packit 1470ea
Packit 1470ea
    

You may have seen Switches like these in GNOME's accessibility menu, which let you turn features like large text and the on-screen keyboard on and off. In this case, the Switch controls our imaginary cookie dispenser. If the Switch is turned on, you can get cookies by clicking the "Get a cookie" Button. If it's turned off, clicking the Button won't do anything.

Packit 1470ea
    <note style="tip">

You can get to the accessibility menu by clicking on the outline of a human, near your name in the upper-right corner of the screen.

</note>
Packit 1470ea
    

Here's how we create the Switch:

Packit 1470ea
    
Packit 1470ea
        // Create the switch that controls whether or not you can win
Packit 1470ea
        this._cookieSwitch = new Gtk.Switch ();
Packit 1470ea
]]>
Packit 1470ea
Packit 1470ea
    

We don't actually need to connect the Switch to anything. All we need to do is write an if statement in our _getACookie function, to check to see if the Switch is turned on. If we wanted to make something happen as soon as you flip the Switch, though, we would connect its notify::active signal, like so:

Packit 1470ea
    
Packit 1470ea
        // Connect the switch to the function that handles it
Packit 1470ea
        this._cookieSwitch.connect ('notify::active', this._cookieDispenser.bind(this));
Packit 1470ea
]]>
Packit 1470ea
Packit 1470ea
    

A Switch is set to the off position by default. If we wanted the Switch to start out turned on, we would set the value of its active property to true when we create it.

Packit 1470ea
    
Packit 1470ea
        this._cookieSwitch = new Gtk.Switch ({ active: true });
Packit 1470ea
]]>
Packit 1470ea
Packit 1470ea
    

Let's just create it normally, though, and then create the Label that goes with it. We want the Switch and the Label to be kept right next to each other, so we'll create a Grid just for them, then put that Grid in our larger Grid that holds all the widgets inside it. Here's what the code looks like to create all that:

Packit 1470ea
    
Packit 1470ea
        // Create the switch that controls whether or not you can win
Packit 1470ea
        this._cookieSwitch = new Gtk.Switch ();
Packit 1470ea
Packit 1470ea
        // Create the label to go with the switch
Packit 1470ea
        this._switchLabel = new Gtk.Label ({
Packit 1470ea
            label: "Cookie dispenser" });
Packit 1470ea
Packit 1470ea
        // Create a grid for the switch and its label
Packit 1470ea
        this._switchGrid = new Gtk.Grid ({
Packit 1470ea
            halign: Gtk.Align.CENTER,
Packit 1470ea
            valign: Gtk.Align.CENTER });
Packit 1470ea
Packit 1470ea
        // Put the switch and its label inside that grid
Packit 1470ea
        this._switchGrid.attach (this._switchLabel, 0, 0, 1, 1);
Packit 1470ea
        this._switchGrid.attach (this._cookieSwitch, 1, 0, 1, 1);
Packit 1470ea
]]>
Packit 1470ea
Packit 1470ea
    

And now we arrange everything in the larger Grid like so.

Packit 1470ea
    
Packit 1470ea
        // Put everything inside the grid
Packit 1470ea
        this._grid.attach (this._cookieButton, 0, 0, 1, 1);
Packit 1470ea
        this._grid.attach (this._switchGrid, 0, 1, 1, 1);
Packit 1470ea
        this._grid.attach (this._cookieLabel, 0, 2, 1, 1);
Packit 1470ea
]]>
Packit 1470ea
Packit 1470ea
    

Now we change the _getACookie function so that it checks to see if the cookie dispenser is turned on. We do that by using the Switch's get_active method. It returns true if the Switch is turned on, and false if the Switch is turned off.

Packit 1470ea
    <note style="tip">

When a method is used in an if statement like this, the code inside the if statement is executed if the method returns true.

</note>
Packit 1470ea
    
Packit 1470ea
    _getACookie() {
Packit 1470ea
Packit 1470ea
        // Is the cookie dispenser turned on?
Packit 1470ea
        if (this._cookieSwitch.get_active()) {
Packit 1470ea
Packit 1470ea
            // Increase the number of cookies by 1 and update the label
Packit 1470ea
            cookies++;
Packit 1470ea
            this._cookieLabel.set_label ("Number of cookies: " + cookies);
Packit 1470ea
Packit 1470ea
        }
Packit 1470ea
Packit 1470ea
    }
Packit 1470ea
]]>
Packit 1470ea
Packit 1470ea
  </section>
Packit 1470ea
Packit 1470ea
  <section id="radio">
Packit 1470ea
    <title>Tuning the radio</title>
Packit 1470ea
Packit 1470ea
    

Another type of input widget we can use is called the RadioButton. You create them in groups, and then only one RadioButton in a group can be selected at a time. They're called RadioButtons because they work like the channel preset button in old-style car radios. The radio could only be tuned to one station at a time, so whenever you pressed one button in, another would pop back out.

Packit 1470ea
Packit 1470ea
    <media type="image" mime="image/png" src="media/03_jssignal_03.png"/>
Packit 1470ea
Packit 1470ea
    

First off, let's change our ApplicationWindow's name and increase its border_width property, so that our widgets aren't packed in too tightly. The border_width is the number of pixels between any widget and the edge of the window.

Packit 1470ea
    
Packit 1470ea
        // Create the application window
Packit 1470ea
        this._window = new Gtk.ApplicationWindow({
Packit 1470ea
            application: this.application,
Packit 1470ea
            window_position: Gtk.WindowPosition.CENTER,
Packit 1470ea
            default_height: 200,
Packit 1470ea
            default_width: 400,
Packit 1470ea
            border_width: 20,
Packit 1470ea
            title: "Choose the one that says 'cookie'!"});
Packit 1470ea
]]>
Packit 1470ea
Packit 1470ea
    

After that, we create the RadioButtons. Remember how they're created in groups? The way we do that, is we set each new RadioButton's group property to the name of another RadioButton.

Packit 1470ea
    
Packit 1470ea
        // Create the radio buttons
Packit 1470ea
        this._cookieRadio = new Gtk.RadioButton ({ label: "Cookie" });
Packit 1470ea
        this._notCookieOne = new Gtk.RadioButton ({ label: "Not cookie",
Packit 1470ea
            group: this._cookieRadio });
Packit 1470ea
        this._notCookieTwo = new Gtk.RadioButton ({ label: "Not cookie",
Packit 1470ea
            group: this._cookieRadio });
Packit 1470ea
]]>
Packit 1470ea
Packit 1470ea
    

Next, we create a Grid for the RadioButtons. Remember, we don't have to arrange things in Grids in the same order that we create them in.

Packit 1470ea
    
Packit 1470ea
        // Arrange the radio buttons in their own grid
Packit 1470ea
        this._radioGrid = new Gtk.Grid ();
Packit 1470ea
        this._radioGrid.attach (this._notCookieOne, 0, 0, 1, 1);
Packit 1470ea
        this._radioGrid.attach (this._cookieRadio, 0, 1, 1, 1);
Packit 1470ea
        this._radioGrid.attach (this._notCookieTwo, 0, 2, 1, 1);
Packit 1470ea
]]>
Packit 1470ea
Packit 1470ea
    

Normally, the RadioButton that's selected by default is the one that's the name of the group. We want the first "Not cookie" button to be selected by default, though, so we use its set_active method.

Packit 1470ea
    <note style="tip">

We could also set its active property to true when we create it.

</note>
Packit 1470ea
    
Packit 1470ea
        // Set the button that will be at the top to be active by default
Packit 1470ea
        this._notCookieOne.set_active (true);
Packit 1470ea
]]>
Packit 1470ea
Packit 1470ea
    

Now we arrange everything in our main Grid like usual ...

Packit 1470ea
    
Packit 1470ea
        // Put everything inside the grid
Packit 1470ea
        this._grid.attach (this._radioGrid, 0, 0, 1, 1);
Packit 1470ea
        this._grid.attach (this._cookieButton, 0, 1, 1, 1);
Packit 1470ea
        this._grid.attach (this._cookieLabel, 0, 2, 1, 1);
Packit 1470ea
]]>
Packit 1470ea
Packit 1470ea
    

And then we change our _getACookie function to test to see if the cookie button is the one that's selected.

Packit 1470ea
    
Packit 1470ea
    _getACookie() {
Packit 1470ea
Packit 1470ea
        // Did you select "cookie" instead of "not cookie"?
Packit 1470ea
        if (this._cookieRadio.get_active()) {
Packit 1470ea
Packit 1470ea
            // Increase the number of cookies by 1 and update the label
Packit 1470ea
            cookies++;
Packit 1470ea
            this._cookieLabel.set_label ("Number of cookies: " + cookies);
Packit 1470ea
Packit 1470ea
        }
Packit 1470ea
Packit 1470ea
    }
Packit 1470ea
]]>
Packit 1470ea
Packit 1470ea
  </section>
Packit 1470ea
Packit 1470ea
  <section id="spell">
Packit 1470ea
    <title>Can you spell "cookie"?</title>
Packit 1470ea
Packit 1470ea
    

The last input widget we're going to cover is the Entry widget, which is used for single-line text entry.

Packit 1470ea
    <note style="tip">

If you need to be able to enter in a whole paragraph or more, like if you are building a text editor, you'll want to look at the much more customizable <link xref="textview.js">TextView</link> widget.

</note>
Packit 1470ea
    <media type="image" mime="image/png" src="media/03_jssignal_04.png"/>
Packit 1470ea
Packit 1470ea
    

After we change the window's name, we create the Entry widget.

Packit 1470ea
    
Packit 1470ea
        // Create the text entry field
Packit 1470ea
        this._spellCookie = new Gtk.Entry ();
Packit 1470ea
]]>
Packit 1470ea
Packit 1470ea
    

Next, we arrange everything in the Grid ...

Packit 1470ea
    
Packit 1470ea
        // Put everything inside the grid
Packit 1470ea
        this._grid.attach (this._spellCookie, 0, 0, 1, 1);
Packit 1470ea
        this._grid.attach (this._cookieButton, 0, 1, 1, 1);
Packit 1470ea
        this._grid.attach (this._cookieLabel, 0, 2, 1, 1);
Packit 1470ea
]]>
Packit 1470ea
Packit 1470ea
    

And now we modify _getACookie's if statement again, using the Entry's get_text method to retrieve the text that you entered into it and see if you spelled "cookie" right. We don't care whether you capitalize "cookie" or not, so we use JavaScript's built-in toLowerCase method to change the Entry's text to all lower case inside the if statement.

Packit 1470ea
    <note style="tip">

An Entry widget doesn't have a label property, which is a set text string that the user can't change. (You can't normally change the label on a Button, for instance.) Instead, it has a text property, which changes to match what the user types in.

</note>
Packit 1470ea
    
Packit 1470ea
    _getACookie() {
Packit 1470ea
Packit 1470ea
        // Did you spell "cookie" correctly?
Packit 1470ea
        if ((this._spellCookie.get_text()).toLowerCase() == "cookie") {
Packit 1470ea
Packit 1470ea
            // Increase the number of cookies by 1 and update the label
Packit 1470ea
            cookies++;
Packit 1470ea
            this._cookieLabel.set_label ("Number of cookies: " + cookies);
Packit 1470ea
Packit 1470ea
        }
Packit 1470ea
Packit 1470ea
    }
Packit 1470ea
]]>
Packit 1470ea
Packit 1470ea
  </section>
Packit 1470ea
Packit 1470ea
  <section id="whats_next">
Packit 1470ea
    <title>What's next?</title>
Packit 1470ea
    

Keep reading, if you'd like to see the complete code for each version of our cookie maker application.

Packit 1470ea
    <note style="tip">

The main JavaScript tutorials page has <link xref="beginner.js#buttons">more detailed code samples</link> for each input widget, including several not covered here.

</note>
Packit 1470ea
Packit 1470ea
  </section>
Packit 1470ea
Packit 1470ea
  <section id="complete">
Packit 1470ea
    <title>Complete code samples</title>
Packit 1470ea
Packit 1470ea
    <links type="section"/>
Packit 1470ea
Packit 1470ea
    <section id="buttonsample">
Packit 1470ea
      <title>Code sample with Button</title>
Packit 1470ea
      <media type="image" mime="image/png" src="media/03_jssignal_01.png"/>
Packit 1470ea
      #!/usr/bin/gjs
Packit 1470ea
Packit 1470ea
imports.gi.versions.Gtk = '3.0';
Packit 1470ea
const Gtk = imports.gi.Gtk;
Packit 1470ea
Packit 1470ea
// We start out with 0 cookies
Packit 1470ea
var cookies = 0;
Packit 1470ea
Packit 1470ea
class GettingTheSignal {
Packit 1470ea
Packit 1470ea
    // Create the application itself
Packit 1470ea
    constructor() {
Packit 1470ea
        this.application = new Gtk.Application();
Packit 1470ea
Packit 1470ea
        // Connect 'activate' and 'startup' signals to the callback functions
Packit 1470ea
        this.application.connect('activate', this._onActivate.bind(this));
Packit 1470ea
        this.application.connect('startup', this._onStartup.bind(this));
Packit 1470ea
    }
Packit 1470ea
Packit 1470ea
    // Callback function for 'activate' signal presents window when active
Packit 1470ea
    _onActivate() {
Packit 1470ea
        this._window.present();
Packit 1470ea
    }
Packit 1470ea
Packit 1470ea
    // Callback function for 'startup' signal builds the UI
Packit 1470ea
    _onStartup() {
Packit 1470ea
        this._buildUI();
Packit 1470ea
    }
Packit 1470ea
Packit 1470ea
    // Build the application's UI
Packit 1470ea
    _buildUI() {
Packit 1470ea
Packit 1470ea
        // Create the application window
Packit 1470ea
        this._window = new Gtk.ApplicationWindow({
Packit 1470ea
            application: this.application,
Packit 1470ea
            window_position: Gtk.WindowPosition.CENTER,
Packit 1470ea
            default_height: 200,
Packit 1470ea
            default_width: 400,
Packit 1470ea
            title: "Click the button to get a cookie!"});
Packit 1470ea
Packit 1470ea
        // Create the label
Packit 1470ea
        this._cookieLabel = new Gtk.Label ({
Packit 1470ea
            label: "Number of cookies: " + cookies });
Packit 1470ea
Packit 1470ea
        // Create the cookie button
Packit 1470ea
        this._cookieButton = new Gtk.Button ({ label: "Get a cookie" });
Packit 1470ea
Packit 1470ea
        // Connect the cookie button to the function that handles clicking it
Packit 1470ea
        this._cookieButton.connect ('clicked', this._getACookie.bind(this));
Packit 1470ea
Packit 1470ea
        // Create a grid to arrange everything inside
Packit 1470ea
        this._grid = new Gtk.Grid ({
Packit 1470ea
            halign: Gtk.Align.CENTER,
Packit 1470ea
            valign: Gtk.Align.CENTER,
Packit 1470ea
            row_spacing: 20 });
Packit 1470ea
Packit 1470ea
        // Put everything inside the grid
Packit 1470ea
        this._grid.attach (this._cookieButton, 0, 0, 1, 1);
Packit 1470ea
        this._grid.attach (this._cookieLabel, 0, 1, 1, 1);
Packit 1470ea
Packit 1470ea
        // Add the grid to the window
Packit 1470ea
        this._window.add (this._grid);
Packit 1470ea
Packit 1470ea
        // Show the window and all child widgets
Packit 1470ea
        this._window.show_all();
Packit 1470ea
Packit 1470ea
    }
Packit 1470ea
Packit 1470ea
    _getACookie() {
Packit 1470ea
Packit 1470ea
        // Increase the number of cookies by 1 and update the label
Packit 1470ea
        cookies++;
Packit 1470ea
        this._cookieLabel.set_label ("Number of cookies: " + cookies);
Packit 1470ea
Packit 1470ea
    }
Packit 1470ea
Packit 1470ea
};
Packit 1470ea
Packit 1470ea
// Run the application
Packit 1470ea
let app = new GettingTheSignal ();
Packit 1470ea
app.application.run (ARGV);
Packit 1470ea
Packit 1470ea
    </section>
Packit 1470ea
Packit 1470ea
    <section id="switchsample">
Packit 1470ea
      <title>Code sample with Switch</title>
Packit 1470ea
      <media type="image" mime="image/png" src="media/03_jssignal_02.png"/>
Packit 1470ea
      #!/usr/bin/gjs
Packit 1470ea
Packit 1470ea
imports.gi.versions.Gtk = '3.0';
Packit 1470ea
const Gtk = imports.gi.Gtk;
Packit 1470ea
Packit 1470ea
// We start out with 0 cookies
Packit 1470ea
var cookies = 0;
Packit 1470ea
Packit 1470ea
class GettingTheSignal {
Packit 1470ea
Packit 1470ea
    // Create the application itself
Packit 1470ea
    constructor() {
Packit 1470ea
        this.application = new Gtk.Application();
Packit 1470ea
Packit 1470ea
        // Connect 'activate' and 'startup' signals to the callback functions
Packit 1470ea
        this.application.connect('activate', this._onActivate.bind(this));
Packit 1470ea
        this.application.connect('startup', this._onStartup.bind(this));
Packit 1470ea
    }
Packit 1470ea
Packit 1470ea
    // Callback function for 'activate' signal presents window when active
Packit 1470ea
    _onActivate() {
Packit 1470ea
        this._window.present();
Packit 1470ea
    }
Packit 1470ea
Packit 1470ea
    // Callback function for 'startup' signal builds the UI
Packit 1470ea
    _onStartup() {
Packit 1470ea
        this._buildUI();
Packit 1470ea
    }
Packit 1470ea
Packit 1470ea
    // Build the application's UI
Packit 1470ea
    _buildUI() {
Packit 1470ea
Packit 1470ea
        // Create the application window
Packit 1470ea
        this._window = new Gtk.ApplicationWindow({
Packit 1470ea
            application: this.application,
Packit 1470ea
            window_position: Gtk.WindowPosition.CENTER,
Packit 1470ea
            default_height: 200,
Packit 1470ea
            default_width: 400,
Packit 1470ea
            title: "Click the button to get a cookie!"});
Packit 1470ea
Packit 1470ea
        // Create the label
Packit 1470ea
        this._cookieLabel = new Gtk.Label ({
Packit 1470ea
            label: "Number of cookies: " + cookies });
Packit 1470ea
Packit 1470ea
        // Create the cookie button
Packit 1470ea
        this._cookieButton = new Gtk.Button ({
Packit 1470ea
            label: "Get a cookie" });
Packit 1470ea
Packit 1470ea
        // Connect the cookie button to the function that handles clicking it
Packit 1470ea
        this._cookieButton.connect ('clicked', this._getACookie.bind(this));
Packit 1470ea
Packit 1470ea
        // Create the switch that controls whether or not you can win
Packit 1470ea
        this._cookieSwitch = new Gtk.Switch ();
Packit 1470ea
Packit 1470ea
        // Create the label to go with the switch
Packit 1470ea
        this._switchLabel = new Gtk.Label ({
Packit 1470ea
            label: "Cookie dispenser" });
Packit 1470ea
Packit 1470ea
        // Create a grid for the switch and its label
Packit 1470ea
        this._switchGrid = new Gtk.Grid ({
Packit 1470ea
            halign: Gtk.Align.CENTER,
Packit 1470ea
            valign: Gtk.Align.CENTER });
Packit 1470ea
Packit 1470ea
        // Put the switch and its label inside that grid
Packit 1470ea
        this._switchGrid.attach (this._switchLabel, 0, 0, 1, 1);
Packit 1470ea
        this._switchGrid.attach (this._cookieSwitch, 1, 0, 1, 1);
Packit 1470ea
Packit 1470ea
        // Create a grid to arrange everything else inside
Packit 1470ea
        this._grid = new Gtk.Grid ({
Packit 1470ea
            halign: Gtk.Align.CENTER,
Packit 1470ea
            valign: Gtk.Align.CENTER,
Packit 1470ea
            row_spacing: 20 });
Packit 1470ea
Packit 1470ea
        // Put everything inside the grid
Packit 1470ea
        this._grid.attach (this._cookieButton, 0, 0, 1, 1);
Packit 1470ea
        this._grid.attach (this._switchGrid, 0, 1, 1, 1);
Packit 1470ea
        this._grid.attach (this._cookieLabel, 0, 2, 1, 1);
Packit 1470ea
Packit 1470ea
        // Add the grid to the window
Packit 1470ea
        this._window.add (this._grid);
Packit 1470ea
Packit 1470ea
        // Show the window and all child widgets
Packit 1470ea
        this._window.show_all();
Packit 1470ea
Packit 1470ea
    }
Packit 1470ea
Packit 1470ea
    _getACookie() {
Packit 1470ea
Packit 1470ea
        // Is the cookie dispenser turned on?
Packit 1470ea
        if (this._cookieSwitch.get_active()) {
Packit 1470ea
Packit 1470ea
            // Increase the number of cookies by 1 and update the label
Packit 1470ea
            cookies++;
Packit 1470ea
            this._cookieLabel.set_label ("Number of cookies: " + cookies);
Packit 1470ea
Packit 1470ea
        }
Packit 1470ea
Packit 1470ea
    }
Packit 1470ea
Packit 1470ea
};
Packit 1470ea
Packit 1470ea
// Run the application
Packit 1470ea
let app = new GettingTheSignal ();
Packit 1470ea
app.application.run (ARGV);
Packit 1470ea
Packit 1470ea
    </section>
Packit 1470ea
Packit 1470ea
    <section id="radiobuttonsample">
Packit 1470ea
      <title>Code sample with RadioButton</title>
Packit 1470ea
      <media type="image" mime="image/png" src="media/03_jssignal_03.png"/>
Packit 1470ea
      #!/usr/bin/gjs
Packit 1470ea
Packit 1470ea
imports.gi.versions.Gtk = '3.0';
Packit 1470ea
const Gtk = imports.gi.Gtk;
Packit 1470ea
Packit 1470ea
// We start out with 0 cookies
Packit 1470ea
var cookies = 0;
Packit 1470ea
Packit 1470ea
class GettingTheSignal {
Packit 1470ea
Packit 1470ea
    // Create the application itself
Packit 1470ea
    constructor() {
Packit 1470ea
        this.application = new Gtk.Application();
Packit 1470ea
Packit 1470ea
        // Connect 'activate' and 'startup' signals to the callback functions
Packit 1470ea
        this.application.connect('activate', this._onActivate.bind(this));
Packit 1470ea
        this.application.connect('startup', this._onStartup.bind(this));
Packit 1470ea
    }
Packit 1470ea
Packit 1470ea
    // Callback function for 'activate' signal presents window when active
Packit 1470ea
    _onActivate() {
Packit 1470ea
        this._window.present();
Packit 1470ea
    }
Packit 1470ea
Packit 1470ea
    // Callback function for 'startup' signal builds the UI
Packit 1470ea
    _onStartup() {
Packit 1470ea
        this._buildUI();
Packit 1470ea
    }
Packit 1470ea
Packit 1470ea
    // Build the application's UI
Packit 1470ea
    _buildUI() {
Packit 1470ea
Packit 1470ea
        // Create the application window
Packit 1470ea
        this._window = new Gtk.ApplicationWindow({
Packit 1470ea
            application: this.application,
Packit 1470ea
            window_position: Gtk.WindowPosition.CENTER,
Packit 1470ea
            default_height: 200,
Packit 1470ea
            default_width: 400,
Packit 1470ea
            border_width: 20,
Packit 1470ea
            title: "Choose the one that says 'cookie'!"});
Packit 1470ea
Packit 1470ea
        // Create the radio buttons
Packit 1470ea
        this._cookieRadio = new Gtk.RadioButton ({ label: "Cookie" });
Packit 1470ea
        this._notCookieOne = new Gtk.RadioButton ({ label: "Not cookie",
Packit 1470ea
            group: this._cookieRadio });
Packit 1470ea
        this._notCookieTwo = new Gtk.RadioButton ({ label: "Not cookie",
Packit 1470ea
            group: this._cookieRadio });
Packit 1470ea
Packit 1470ea
        // Arrange the radio buttons in their own grid
Packit 1470ea
        this._radioGrid = new Gtk.Grid ();
Packit 1470ea
        this._radioGrid.attach (this._notCookieOne, 0, 0, 1, 1);
Packit 1470ea
        this._radioGrid.attach (this._cookieRadio, 0, 1, 1, 1);
Packit 1470ea
        this._radioGrid.attach (this._notCookieTwo, 0, 2, 1, 1);
Packit 1470ea
Packit 1470ea
        // Set the button that will be at the top to be active by default
Packit 1470ea
        this._notCookieOne.set_active (true);
Packit 1470ea
Packit 1470ea
        // Create the cookie button
Packit 1470ea
        this._cookieButton = new Gtk.Button ({
Packit 1470ea
            label: "Get a cookie" });
Packit 1470ea
Packit 1470ea
        // Connect the cookie button to the function that handles clicking it
Packit 1470ea
        this._cookieButton.connect ('clicked', this._getACookie.bind(this));
Packit 1470ea
Packit 1470ea
        // Create the label
Packit 1470ea
        this._cookieLabel = new Gtk.Label ({
Packit 1470ea
            label: "Number of cookies: " + cookies });
Packit 1470ea
Packit 1470ea
        // Create a grid to arrange everything inside
Packit 1470ea
        this._grid = new Gtk.Grid ({
Packit 1470ea
            halign: Gtk.Align.CENTER,
Packit 1470ea
            valign: Gtk.Align.CENTER,
Packit 1470ea
            row_spacing: 20 });
Packit 1470ea
Packit 1470ea
        // Put everything inside the grid
Packit 1470ea
        this._grid.attach (this._radioGrid, 0, 0, 1, 1);
Packit 1470ea
        this._grid.attach (this._cookieButton, 0, 1, 1, 1);
Packit 1470ea
        this._grid.attach (this._cookieLabel, 0, 2, 1, 1);
Packit 1470ea
Packit 1470ea
        // Add the grid to the window
Packit 1470ea
        this._window.add (this._grid);
Packit 1470ea
Packit 1470ea
        // Show the window and all child widgets
Packit 1470ea
        this._window.show_all();
Packit 1470ea
Packit 1470ea
    }
Packit 1470ea
Packit 1470ea
    _getACookie() {
Packit 1470ea
Packit 1470ea
        // Did you select "cookie" instead of "not cookie"?
Packit 1470ea
        if (this._cookieRadio.get_active()) {
Packit 1470ea
Packit 1470ea
            // Increase the number of cookies by 1 and update the label
Packit 1470ea
            cookies++;
Packit 1470ea
            this._cookieLabel.set_label ("Number of cookies: " + cookies);
Packit 1470ea
Packit 1470ea
        }
Packit 1470ea
Packit 1470ea
    }
Packit 1470ea
Packit 1470ea
};
Packit 1470ea
Packit 1470ea
// Run the application
Packit 1470ea
let app = new GettingTheSignal ();
Packit 1470ea
app.application.run (ARGV);
Packit 1470ea
Packit 1470ea
    </section>
Packit 1470ea
Packit 1470ea
    <section id="entrysample">
Packit 1470ea
      <title>Code sample with Entry</title>
Packit 1470ea
      <media type="image" mime="image/png" src="media/03_jssignal_04.png"/>
Packit 1470ea
      #!/usr/bin/gjs
Packit 1470ea
Packit 1470ea
imports.gi.versions.Gtk = '3.0';
Packit 1470ea
const Gtk = imports.gi.Gtk;
Packit 1470ea
Packit 1470ea
// We start out with 0 cookies
Packit 1470ea
var cookies = 0;
Packit 1470ea
Packit 1470ea
class GettingTheSignal {
Packit 1470ea
Packit 1470ea
    // Create the application itself
Packit 1470ea
    constructor() {
Packit 1470ea
        this.application = new Gtk.Application();
Packit 1470ea
Packit 1470ea
        // Connect 'activate' and 'startup' signals to the callback functions
Packit 1470ea
        this.application.connect('activate', this._onActivate.bind(this));
Packit 1470ea
        this.application.connect('startup', this._onStartup.bind(this));
Packit 1470ea
    }
Packit 1470ea
Packit 1470ea
    // Callback function for 'activate' signal presents window when active
Packit 1470ea
    _onActivate() {
Packit 1470ea
        this._window.present();
Packit 1470ea
    }
Packit 1470ea
Packit 1470ea
    // Callback function for 'startup' signal builds the UI
Packit 1470ea
    _onStartup() {
Packit 1470ea
        this._buildUI();
Packit 1470ea
    }
Packit 1470ea
Packit 1470ea
    // Build the application's UI
Packit 1470ea
    _buildUI() {
Packit 1470ea
Packit 1470ea
        // Create the application window
Packit 1470ea
        this._window = new Gtk.ApplicationWindow({
Packit 1470ea
            application: this.application,
Packit 1470ea
            window_position: Gtk.WindowPosition.CENTER,
Packit 1470ea
            default_height: 200,
Packit 1470ea
            default_width: 400,
Packit 1470ea
            border_width: 20,
Packit 1470ea
            title: "Spell 'cookie' to get a cookie!"});
Packit 1470ea
Packit 1470ea
        // Create the text entry field
Packit 1470ea
        this._spellCookie = new Gtk.Entry ();
Packit 1470ea
Packit 1470ea
        // Create the cookie button
Packit 1470ea
        this._cookieButton = new Gtk.Button ({
Packit 1470ea
            label: "Get a cookie" });
Packit 1470ea
Packit 1470ea
        // Connect the cookie button to the function that handles clicking it
Packit 1470ea
        this._cookieButton.connect ('clicked', this._getACookie.bind(this));
Packit 1470ea
Packit 1470ea
        // Create the label
Packit 1470ea
        this._cookieLabel = new Gtk.Label ({
Packit 1470ea
            label: "Number of cookies: " + cookies });
Packit 1470ea
Packit 1470ea
        // Create a grid to arrange everything inside
Packit 1470ea
        this._grid = new Gtk.Grid ({
Packit 1470ea
            halign: Gtk.Align.CENTER,
Packit 1470ea
            valign: Gtk.Align.CENTER,
Packit 1470ea
            row_spacing: 20 });
Packit 1470ea
Packit 1470ea
        // Put everything inside the grid
Packit 1470ea
        this._grid.attach (this._spellCookie, 0, 0, 1, 1);
Packit 1470ea
        this._grid.attach (this._cookieButton, 0, 1, 1, 1);
Packit 1470ea
        this._grid.attach (this._cookieLabel, 0, 2, 1, 1);
Packit 1470ea
Packit 1470ea
        // Add the grid to the window
Packit 1470ea
        this._window.add (this._grid);
Packit 1470ea
Packit 1470ea
        // Show the window and all child widgets
Packit 1470ea
        this._window.show_all();
Packit 1470ea
Packit 1470ea
    }
Packit 1470ea
Packit 1470ea
    _getACookie() {
Packit 1470ea
Packit 1470ea
        // Did you spell "cookie" correctly?
Packit 1470ea
        if ((this._spellCookie.get_text()).toLowerCase() == "cookie") {
Packit 1470ea
Packit 1470ea
            // Increase the number of cookies by 1 and update the label
Packit 1470ea
            cookies++;
Packit 1470ea
            this._cookieLabel.set_label ("Number of cookies: " + cookies);
Packit 1470ea
Packit 1470ea
        }
Packit 1470ea
Packit 1470ea
    }
Packit 1470ea
Packit 1470ea
};
Packit 1470ea
Packit 1470ea
// Run the application
Packit 1470ea
let app = new GettingTheSignal ();
Packit 1470ea
app.application.run (ARGV);
Packit 1470ea
Packit 1470ea
    </section>
Packit 1470ea
Packit 1470ea
  </section>
Packit 1470ea
Packit 1470ea
</page>