## GwyDataWindow

GwyDataWindow — Data display window

## Synopsis

    #include <libgwydgets/gwydgets.h>

                        GwyDataWindow;
                        GwyDataWindowClass;
    GtkWidget*          gwy_data_window_new                 (GwyDataView *data_view);
    GwyDataView*        gwy_data_window_get_data_view       (GwyDataWindow *data_window);
    GtkWidget*          gwy_data_window_get_color_axis      (GwyDataWindow *data_window);
    GwyContainer*       gwy_data_window_get_data            (GwyDataWindow *data_window);
    void                gwy_data_window_set_zoom            (GwyDataWindow *data_window,
                                                             gint izoom);
    const gchar*        gwy_data_window_get_data_name       (GwyDataWindow *data_window);
    void                gwy_data_window_set_data_name       (GwyDataWindow *data_window,
                                                             const gchar *data_name);
    GtkWidget*          gwy_data_window_get_ul_corner_widget
                                                            (GwyDataWindow *data_window);
    void                gwy_data_window_set_ul_corner_widget
                                                            (GwyDataWindow *data_window,
                                                             GtkWidget *corner);
    void                gwy_data_window_class_set_tooltips  (GtkTooltips *tips);
    GtkTooltips*        gwy_data_window_class_get_tooltips  (void);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkObject
                   +----GtkWidget
                         +----GtkContainer
                               +----GtkBin
                                     +----GtkWindow
                                           +----GwyDataWindow

## Implemented Interfaces

GwyDataWindow implements AtkImplementorIface and GtkBuildable.

## Properties

      "color-axis"               GwyColorAxis*         : Read
      "data-name"                gchar*                : Read / Write
      "data-view"                GwyDataView*          : Read
      "ul-corner"                GtkWidget*            : Read / Write

## Description

GwyDataWindow encapsulates a GwyDataView together with other controls. You can create a data window for a data view with `gwy_data_window_new()`.

## Details

### GwyDataWindow

    typedef struct _GwyDataWindow GwyDataWindow;

### GwyDataWindowClass

    typedef struct {
        GtkWindowClass parent_class;

        void (*reserved1)(void);
        void (*reserved2)(void);
        void (*reserved3)(void);
    } GwyDataWindowClass;

### gwy_data_window_new ()

    GtkWidget*          gwy_data_window_new                 (GwyDataView *data_view);

Creates a new data displaying window.

`data_view` : | A GwyDataView containing the data-displaying widget to show.
Returns : | A newly created widget, as GtkWidget.

### gwy_data_window_get_data_view ()

    GwyDataView*        gwy_data_window_get_data_view       (GwyDataWindow *data_window);

Returns the data view widget a data window currently shows.

`data_window` : | A data view window.
Returns : | The currently shown data view.

### gwy_data_window_get_color_axis ()

    GtkWidget*          gwy_data_window_get_color_axis      (GwyDataWindow *data_window);

Returns the color axis widget displayed by a data window.

`data_window` : | A data view window.
Returns : | The color axis.

### gwy_data_window_get_data ()

    GwyContainer*       gwy_data_window_get_data            (GwyDataWindow *data_window);

Returns the data for the data view a data window currently shows.

`data_window` : | A data view window.
Returns : | The data as GwyContainer.

### gwy_data_window_set_zoom ()

    void                gwy_data_window_set_zoom            (GwyDataWindow *data_window,
                                                             gint izoom);

Sets the zoom of a data window to `izoom`.

When `izoom` is -1 it zooms out; when `izoom` is 1 it zooms out. Otherwise the new zoom value is set to `izoom`/10000.

`data_window` : | A data window.
`izoom` : | The new zoom value (as an integer).

### gwy_data_window_get_data_name ()

    const gchar*        gwy_data_window_get_data_name       (GwyDataWindow *data_window);

Gets the data name part of a data window's title.

`data_window` : | A data window.
Returns : | The data name as a string owned by the window.

### gwy_data_window_set_data_name ()

    void                gwy_data_window_set_data_name       (GwyDataWindow *data_window,
                                                             const gchar *data_name);

Sets the data name of a data window.

The data name is used in the window's title.

`data_window` : | A data window.
`data_name` : | New data name.

### gwy_data_window_get_ul_corner_widget ()

    GtkWidget*          gwy_data_window_get_ul_corner_widget
                                                            (GwyDataWindow *data_window);

Returns the upper left corner widget of `data_window`.

`data_window` : | A data window.
Returns : | The upper left corner widget as a GtkWidget, `NULL` if there is no such widget.

### gwy_data_window_set_ul_corner_widget ()

    void                gwy_data_window_set_ul_corner_widget
                                                            (GwyDataWindow *data_window,
                                                             GtkWidget *corner);

Sets the widget in upper left corner of a data window to `corner`.

`data_window` : | A data window.
`corner` : | A widget to set as upper left corner widget, many be `NULL` to just remove any eventual existing one.

### gwy_data_window_class_set_tooltips ()

    void                gwy_data_window_class_set_tooltips  (GtkTooltips *tips);

Sets the tooltips object to use for adding tooltips to data window parts.

This is a class method. It affects only newly cerated data windows, existing data windows will continue to use the tooltips they were constructed with.

If no class tooltips object is set before first GwyDataWindow is created, the class instantiates one on its own. You can normally obtain it with `gwy_data_window_class_get_tooltips()` then. The class takes a reference on the tooltips in either case.

`tips` : | Tooltips object GwyDataWindow's should use for setting tooltips. A `NULL` value disables tooltips altogether.

### gwy_data_window_class_get_tooltips ()

    GtkTooltips*        gwy_data_window_class_get_tooltips  (void);

Gets the tooltips object used for adding tooltips to Data window parts.

Returns : | The GtkTooltips object.

## Property Details

### The `"color-axis"` property

      "color-axis"               GwyColorAxis*         : Read

The color axis widget displayed in the window.

### The `"data-name"` property

      "data-name"                gchar*                : Read / Write

Data name used in window title.

Default value: ""

### The `"data-view"` property

      "data-view"                GwyDataView*          : Read

The data view widget displayed in the window.

### The `"ul-corner"` property

      "ul-corner"                GtkWidget*            : Read / Write

The widget in the upper left corner.

## See Also

GwyDataView -- basic data display widget