GNU Info

(gtk.info)GtkWindow

---

Prev: GtkWidget Up: Widgets

---

Enter node , (file) or (file)node

The window widget
=================

Description
-----------

Options
-------

 - User Option: type
     The TYPE options specify how this widget will interact with the
     window manager. Currently the following types and the effect they
     have on the window to window manager interaction is as follows.
        * `GTK_WINDOW_TOPLEVEL'
             * The option `GTK_WINDOW_TOPLEVEL' is usually used for the
               main application window that will remain for the entire
               application run.

        * `GTK_WINDOW_DIALOG'
             * The option `GTK_WINDOW_DIALOG' is usually used for
               transient windows. These windows will open up, gather
               some input or provide some application specific updates,
               then close. The window manager is free not to provide
               all the 'normal' window functions to this window.

        * `GTK_WINDOW_POPUP'
             * The option `GTK_WINDOW_POPUP' is usually used for
               transient windows.  These windows are typically used for
               when no user interaction is required, to notify the user
               of some condition. Other uses for these types of windows
               are for 'about windows', startup windows and the like.
               Typically the window manager will *not* provide the
               usual widgets that surround the window. At the most all
               that will be provided is a border. Also note that
               windows that set this TYPE will not be in any window
               list of the window manager. Though this window will
               *not* get the kill and close widgets of the window
               manager they still can receive said events and should be
               taken into account.

 - User Option: title
     The TITLE option will set the title of the window in the window
     manager.  *Note:* On windows that have the TYPE option set to
     `GTK_WINDOW_POPUP' there is a strong possibility that this will
     text will not be seen.

 - User Option: position
     The POSITION option will determine where the window will be
     displayed when it is finally drawn to the screen. Currently the
     following positions  and the effect they have on window placement
     can be specified.

        * `GTK_WIN_POS_NONE'
             * This POSITION type will allow the window manager full
               freedom, depending on the current settings in the window
               manager. As to where the window will be placed.

        * `GTK_WIN_POS_CENTER'
             * This POSITION option will cause the window to center
               itself on the the screen. This option setting will take
               into account the VIRTUAL SCREEN size when calculating
               the center. This is *not* the same as the VIRTUAL
               DESKTOP setting of many window managers. It will center
               itself on the current VIRTUAL DESKTOP.

        * `GTK_WIN_POS_MOUSE'
               This POSITION option will cause the window to center
               itself under the mouse pointers' current location.
               Typical uses for this setting is in
               warning/error/informational dialogs where user
               interaction is desired.

Signals
-------

 - Signal: void GtkWindow::move_resize (GtkWindow *WINDOW, gint *X,
          gint *Y, gint WIDTH, gint HEIGHT)

 - Signal: void GtkWindow::set_focus (GtkWindow *WINDOW, GtkWidget
          *FOCUS)

Functions
---------

 - Function: guint gtk_window_get_type (void)
     Returns the `GtkWindow' type identifier.

 - Function: GtkWidget* gtk_window_new (GtkWindowType TYPE)
     Create a new `GtkWindow' object. The new widget is returned as a
     pointer to a `GtkWidget' object. `NULL' is returned on failure.
     The TYPE can be one of `GTK_WINDOW_TOPLEVEL', `GTK_WINDOW_DIALOG'
     or, `GTK_WINDOW_POPUP'. The TYPE value determines how this widget
     will interact with the window manager.

 - Function: void gtk_window_set_title (GtkWindow *WINDOW, gchar *TITLE)
     Set the title of this window to the text in the TITLE argument. It
     is important to not set the fields of the `GtkWindow' structure
     directly.

 - Function: void gtk_window_set_focus (GtkWindow *WINDOW, GtkWidget
          *FOCUS)

 - Function: void gtk_window_set_default (GtkWindow *WINDOW, GtkWidget
          *DEFAULTW)

 - Function: void gtk_window_set_policy (GtkWindow *WINDOW, gint
          ALLOW_SHRINK, gint ALLOW_GROW, gint AUTO_SHRINK)

 - Function: void gtk_window_add_accelerator_table (GtkWindow *WINDOW,
          GtkAcceleratorTable *TABLE)

 - Function: void gtk_window_remove_accelerator_table (GtkWindow
          *WINDOW, GtkAcceleratorTable *TABLE)

 - Function: void gtk_window_position (GtkWindow *WINDOW,
          GtkWindowPosition POSITION)
     Set the position that the window will be at when it is finally
     drawn to the screen. The POSITION argument effects the the
     position as described above.

 - Function: GtkWindow* GTK_WINDOW (gpointer OBJ)
     Cast a generic pointer to `GtkWindow*'. Note: Standard Macros,
     for more info.

 - Function: GtkWindowClass* GTK_WINDOW_CLASS (gpointer CLASS)
     Cast a generic pointer to `GtkWindowClass*'. Note: Standard
     Macros, for more info.

 - Function: gint GTK_IS_WINDOW (gpointer OBJ)
     Determine if a generic pointer refers to a `GtkWindow' object.
     Note: Standard Macros, for more info.