GwyDataWindow

GwyDataWindow — Data display window

Synopsis




            GwyDataWindow;
            GwyDataWindowClass;
GtkWidget*  gwy_data_window_new             (GwyDataView *data_view);
GwyDataView* gwy_data_window_get_data_view  (GwyDataWindow *data_window);
GwyContainer* gwy_data_window_get_data      (GwyDataWindow *data_window);
void        gwy_data_window_set_zoom        (GwyDataWindow *data_window,
                                             gint izoom);
void        gwy_data_window_update_title    (GwyDataWindow *data_window);
gchar*      gwy_data_window_get_base_name   (GwyDataWindow *data_window);
GtkWidget*  gwy_data_window_get_ul_corner_widget
                                            (GwyDataWindow *data_window);
void        gwy_data_window_set_ul_corner_widget
                                            (GwyDataWindow *data_window,
                                             GtkWidget *corner);

Object Hierarchy


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

Implemented Interfaces

GwyDataWindow implements AtkImplementorIface.

Signal Prototypes


"title-changed"
            void        user_function      (GwyDataWindow *gwydatawindow,
                                            gpointer user_data);

Description

Details

GwyDataWindow

typedef struct _GwyDataWindow GwyDataWindow;


GwyDataWindowClass

typedef struct {
    GtkWindowClass parent_class;

    void (*title_changed)(GwyDataWindow *data_window);

    gpointer reserved1;
    gpointer reserved2;
} 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 this data window currently shows.

data_window : A data view window.
Returns : The currently shown GwyDataView.

gwy_data_window_get_data ()

GwyContainer* gwy_data_window_get_data      (GwyDataWindow *data_window);

Returns the data for the data view this 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_update_title ()

void        gwy_data_window_update_title    (GwyDataWindow *data_window);

Updates the title of data_window to reflect current state.

FIXME: (a) the window title format should be configurable (b) this should probably happen automatically(?).

data_window : A data window.

gwy_data_window_get_base_name ()

gchar*      gwy_data_window_get_base_name   (GwyDataWindow *data_window);

Creates a string usable as a data_window window name/title.

This is the prefered data window representation in option menus, infoboxes, etc.

data_window : A data window.
Returns : The window name as a newly allocated string. It should be freed when no longer needed.

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.

Signals

The "title-changed" signal

void        user_function                  (GwyDataWindow *gwydatawindow,
                                            gpointer user_data);

The ::title-changed signal is emitted when the title of GwyDataWindow changes.

gwydatawindow : The GwyDataWindow which received the signal.
user_data :user data set when the signal handler was connected.