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
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
// Take a look at the license at the top of the repository in the LICENSE file.

use crate::{Notebook, Widget};
use glib::translate::*;
use glib::IsA;
use libc::c_int;

impl Notebook {
    /// Appends a page to @self.
    /// ## `child`
    /// the [`Widget`][crate::Widget] to use as the contents of the page
    /// ## `tab_label`
    /// the [`Widget`][crate::Widget] to be used as the label
    ///   for the page, or [`None`] to use the default label, “page N”
    ///
    /// # Returns
    ///
    /// the index (starting from 0) of the appended
    ///   page in the notebook, or -1 if function fails
    #[doc(alias = "gtk_notebook_append_page")]
    pub fn append_page<T: IsA<Widget>, U: IsA<Widget>>(
        &self,
        child: &T,
        tab_label: Option<&U>,
    ) -> u32 {
        unsafe {
            let ret = ffi::gtk_notebook_append_page(
                self.to_glib_none().0,
                child.as_ref().to_glib_none().0,
                tab_label.map(|p| p.as_ref()).to_glib_none().0,
            );
            assert!(ret >= 0);
            ret as u32
        }
    }

    /// Appends a page to @self, specifying the widget to use as the
    /// label in the popup menu.
    /// ## `child`
    /// the [`Widget`][crate::Widget] to use as the contents of the page
    /// ## `tab_label`
    /// the [`Widget`][crate::Widget] to be used as the label
    ///   for the page, or [`None`] to use the default label, “page N”
    /// ## `menu_label`
    /// the widget to use as a label for the
    ///   page-switch menu, if that is enabled. If [`None`], and @tab_label
    ///   is a [`Label`][crate::Label] or [`None`], then the menu label will be a newly
    ///   created label with the same text as @tab_label; if @tab_label
    ///   is not a [`Label`][crate::Label], @menu_label must be specified if the
    ///   page-switch menu is to be used.
    ///
    /// # Returns
    ///
    /// the index (starting from 0) of the appended
    ///   page in the notebook, or -1 if function fails
    #[doc(alias = "gtk_notebook_append_page_menu")]
    pub fn append_page_menu<T, U, V>(
        &self,
        child: &T,
        tab_label: Option<&U>,
        menu_label: Option<&V>,
    ) -> u32
    where
        T: IsA<Widget>,
        U: IsA<Widget>,
        V: IsA<Widget>,
    {
        unsafe {
            let ret = ffi::gtk_notebook_append_page_menu(
                self.to_glib_none().0,
                child.as_ref().to_glib_none().0,
                tab_label.map(|p| p.as_ref()).to_glib_none().0,
                menu_label.map(|p| p.as_ref()).to_glib_none().0,
            );
            assert!(ret >= 0);
            ret as u32
        }
    }

    /// Returns the page number of the current page.
    ///
    /// # Returns
    ///
    /// the index (starting from 0) of the current
    ///   page in the notebook. If the notebook has no pages,
    ///   then -1 will be returned.
    #[doc(alias = "gtk_notebook_get_current_page")]
    #[doc(alias = "get_current_page")]
    pub fn current_page(&self) -> Option<u32> {
        unsafe {
            let ret = ffi::gtk_notebook_get_current_page(self.to_glib_none().0);
            if ret >= 0 {
                Some(ret as u32)
            } else {
                None
            }
        }
    }

    /// Gets the number of pages in a notebook.
    ///
    /// # Returns
    ///
    /// the number of pages in the notebook
    #[doc(alias = "gtk_notebook_get_n_pages")]
    #[doc(alias = "get_n_pages")]
    pub fn n_pages(&self) -> u32 {
        unsafe {
            let ret = ffi::gtk_notebook_get_n_pages(self.to_glib_none().0);
            assert!(ret >= 0);
            ret as u32
        }
    }

    /// Returns the child widget contained in page number @page_num.
    /// ## `page_num`
    /// the index of a page in the notebook, or -1
    ///   to get the last page
    ///
    /// # Returns
    ///
    /// the child widget, or [`None`] if @page_num
    /// is out of bounds
    #[doc(alias = "gtk_notebook_get_nth_page")]
    #[doc(alias = "get_nth_page")]
    pub fn nth_page(&self, page_num: Option<u32>) -> Option<Widget> {
        unsafe {
            from_glib_none(ffi::gtk_notebook_get_nth_page(
                self.to_glib_none().0,
                page_num.map_or(-1, |n| n as c_int),
            ))
        }
    }

    /// Insert a page into @self at the given position.
    /// ## `child`
    /// the [`Widget`][crate::Widget] to use as the contents of the page
    /// ## `tab_label`
    /// the [`Widget`][crate::Widget] to be used as the label
    ///   for the page, or [`None`] to use the default label, “page N”
    /// ## `position`
    /// the index (starting at 0) at which to insert the page,
    ///   or -1 to append the page after all other pages
    ///
    /// # Returns
    ///
    /// the index (starting from 0) of the inserted
    ///   page in the notebook, or -1 if function fails
    #[doc(alias = "gtk_notebook_insert_page")]
    pub fn insert_page<T, U>(&self, child: &T, tab_label: Option<&U>, position: Option<u32>) -> u32
    where
        T: IsA<Widget>,
        U: IsA<Widget>,
    {
        unsafe {
            let ret = ffi::gtk_notebook_insert_page(
                self.to_glib_none().0,
                child.as_ref().to_glib_none().0,
                tab_label.map(|p| p.as_ref()).to_glib_none().0,
                position.map_or(-1, |n| n as c_int),
            );
            assert!(ret >= 0);
            ret as u32
        }
    }

    /// Insert a page into @self at the given position, specifying
    /// the widget to use as the label in the popup menu.
    /// ## `child`
    /// the [`Widget`][crate::Widget] to use as the contents of the page
    /// ## `tab_label`
    /// the [`Widget`][crate::Widget] to be used as the label
    ///   for the page, or [`None`] to use the default label, “page N”
    /// ## `menu_label`
    /// the widget to use as a label for the
    ///   page-switch menu, if that is enabled. If [`None`], and @tab_label
    ///   is a [`Label`][crate::Label] or [`None`], then the menu label will be a newly
    ///   created label with the same text as @tab_label; if @tab_label
    ///   is not a [`Label`][crate::Label], @menu_label must be specified if the
    ///   page-switch menu is to be used.
    /// ## `position`
    /// the index (starting at 0) at which to insert the page,
    ///   or -1 to append the page after all other pages.
    ///
    /// # Returns
    ///
    /// the index (starting from 0) of the inserted
    ///   page in the notebook
    #[doc(alias = "gtk_notebook_insert_page_menu")]
    pub fn insert_page_menu<T, U, V>(
        &self,
        child: &T,
        tab_label: Option<&U>,
        menu_label: Option<&V>,
        position: Option<u32>,
    ) -> u32
    where
        T: IsA<Widget>,
        U: IsA<Widget>,
        V: IsA<Widget>,
    {
        unsafe {
            let ret = ffi::gtk_notebook_insert_page_menu(
                self.to_glib_none().0,
                child.as_ref().to_glib_none().0,
                tab_label.map(|p| p.as_ref()).to_glib_none().0,
                menu_label.map(|p| p.as_ref()).to_glib_none().0,
                position.map_or(-1, |n| n as c_int),
            );
            assert!(ret >= 0);
            ret as u32
        }
    }
    /// Finds the index of the page which contains the given child
    /// widget.
    /// ## `child`
    /// a [`Widget`][crate::Widget]
    ///
    /// # Returns
    ///
    /// the index of the page containing @child, or
    ///   -1 if @child is not in the notebook
    #[doc(alias = "gtk_notebook_page_num")]
    pub fn page_num<T: IsA<Widget>>(&self, child: &T) -> Option<u32> {
        unsafe {
            let ret =
                ffi::gtk_notebook_page_num(self.to_glib_none().0, child.as_ref().to_glib_none().0);
            if ret >= 0 {
                Some(ret as u32)
            } else {
                None
            }
        }
    }
    /// Prepends a page to @self.
    /// ## `child`
    /// the [`Widget`][crate::Widget] to use as the contents of the page
    /// ## `tab_label`
    /// the [`Widget`][crate::Widget] to be used as the label
    ///   for the page, or [`None`] to use the default label, “page N”
    ///
    /// # Returns
    ///
    /// the index (starting from 0) of the prepended
    ///   page in the notebook, or -1 if function fails
    #[doc(alias = "gtk_notebook_prepend_page")]
    pub fn prepend_page<T, U>(&self, child: &T, tab_label: Option<&U>) -> u32
    where
        T: IsA<Widget>,
        U: IsA<Widget>,
    {
        unsafe {
            let ret = ffi::gtk_notebook_prepend_page(
                self.to_glib_none().0,
                child.as_ref().to_glib_none().0,
                tab_label.map(|p| p.as_ref()).to_glib_none().0,
            );
            assert!(ret >= 0);
            ret as u32
        }
    }

    /// Prepends a page to @self, specifying the widget to use as the
    /// label in the popup menu.
    /// ## `child`
    /// the [`Widget`][crate::Widget] to use as the contents of the page
    /// ## `tab_label`
    /// the [`Widget`][crate::Widget] to be used as the label
    ///   for the page, or [`None`] to use the default label, “page N”
    /// ## `menu_label`
    /// the widget to use as a label for the
    ///   page-switch menu, if that is enabled. If [`None`], and @tab_label
    ///   is a [`Label`][crate::Label] or [`None`], then the menu label will be a newly
    ///   created label with the same text as @tab_label; if @tab_label
    ///   is not a [`Label`][crate::Label], @menu_label must be specified if the
    ///   page-switch menu is to be used.
    ///
    /// # Returns
    ///
    /// the index (starting from 0) of the prepended
    ///   page in the notebook, or -1 if function fails
    #[doc(alias = "gtk_notebook_prepend_page_menu")]
    pub fn prepend_page_menu<T, U, V>(
        &self,
        child: &T,
        tab_label: Option<&U>,
        menu_label: Option<&V>,
    ) -> u32
    where
        T: IsA<Widget>,
        U: IsA<Widget>,
        V: IsA<Widget>,
    {
        unsafe {
            let ret = ffi::gtk_notebook_prepend_page_menu(
                self.to_glib_none().0,
                child.as_ref().to_glib_none().0,
                tab_label.map(|p| p.as_ref()).to_glib_none().0,
                menu_label.map(|p| p.as_ref()).to_glib_none().0,
            );
            assert!(ret >= 0);
            ret as u32
        }
    }

    /// Removes a page from the notebook given its index
    /// in the notebook.
    /// ## `page_num`
    /// the index of a notebook page, starting
    ///   from 0. If -1, the last page will be removed.
    #[doc(alias = "gtk_notebook_remove_page")]
    pub fn remove_page(&self, page_num: Option<u32>) {
        unsafe {
            ffi::gtk_notebook_remove_page(
                self.to_glib_none().0,
                page_num.map_or(-1, |n| n as c_int),
            );
        }
    }

    /// Reorders the page containing @child, so that it appears in position
    /// @position.
    ///
    /// If @position is greater than or equal to the number of children in
    /// the list or negative, @child will be moved to the end of the list.
    /// ## `child`
    /// the child to move
    /// ## `position`
    /// the new position, or -1 to move to the end
    #[doc(alias = "gtk_notebook_reorder_child")]
    pub fn reorder_child<T: IsA<Widget>>(&self, child: &T, position: Option<u32>) {
        unsafe {
            ffi::gtk_notebook_reorder_child(
                self.to_glib_none().0,
                child.as_ref().to_glib_none().0,
                position.map_or(-1, |n| n as c_int),
            );
        }
    }

    /// Switches to the page number @page_num.
    ///
    /// Note that due to historical reasons, GtkNotebook refuses
    /// to switch to a page unless the child widget is visible.
    /// Therefore, it is recommended to show child widgets before
    /// adding them to a notebook.
    /// ## `page_num`
    /// index of the page to switch to, starting from 0.
    ///   If negative, the last page will be used. If greater
    ///   than the number of pages in the notebook, nothing
    ///   will be done.
    #[doc(alias = "gtk_notebook_set_current_page")]
    pub fn set_current_page(&self, page_num: Option<u32>) {
        unsafe {
            ffi::gtk_notebook_set_current_page(
                self.to_glib_none().0,
                page_num.map_or(-1, |n| n as c_int),
            );
        }
    }
}