EogWindow

## EogWindow EogWindow |

## Synopsis

    #define             EOG_WINDOW_ERROR
    enum                EogWindowGalleryPos;
    enum                EogWindowMode;
    enum                EogWindowError;
    enum                EogStartupFlags;
    struct              EogWindow;
    GtkWidget *         eog_window_new                      (EogStartupFlags flags);
    EogWindowMode       eog_window_get_mode                 (EogWindow *window);
    void                eog_window_set_mode                 (EogWindow *window,
                                                             EogWindowMode mode);
    GtkUIManager *      eog_window_get_ui_manager           (EogWindow *window);
    EogListStore *      eog_window_get_store                (EogWindow *window);
    GtkWidget *         eog_window_get_view                 (EogWindow *window);
    GtkWidget *         eog_window_get_sidebar              (EogWindow *window);
    GtkWidget *         eog_window_get_thumb_view           (EogWindow *window);
    GtkWidget *         eog_window_get_thumb_nav            (EogWindow *window);
    GtkWidget *         eog_window_get_statusbar            (EogWindow *window);
    EogImage *          eog_window_get_image                (EogWindow *window);
    void                eog_window_open_file_list           (EogWindow *window,
                                                             GSList *file_list);
    gboolean            eog_window_is_empty                 (EogWindow *window);
    void                eog_window_reload_image             (EogWindow *window);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkWidget
                   +----GtkContainer
                         +----GtkBin
                               +----GtkWindow
                                     +----EogWindow

## Implemented Interfaces

EogWindow implements AtkImplementorIface and GtkBuildable.

## Properties

      "gallery-position"         EogWindowGalleryPos   : Read / Write
      "gallery-resizable"        gboolean              : Read / Write
      "startup-flags"            EogStartupFlags       : Read / Write / Construct Only

## Signals

      "prepared"                                       : Run Last

## Description

## Details

### EOG_WINDOW_ERROR

    #define EOG_WINDOW_ERROR           (eog_window_error_quark ())

### enum EogWindowGalleryPos

    typedef enum {
    	EOG_WINDOW_GALLERY_POS_BOTTOM,
    	EOG_WINDOW_GALLERY_POS_LEFT,
    	EOG_WINDOW_GALLERY_POS_TOP,
    	EOG_WINDOW_GALLERY_POS_RIGHT
    } EogWindowGalleryPos;

### enum EogWindowMode

    typedef enum {
    	EOG_WINDOW_MODE_UNKNOWN,
    	EOG_WINDOW_MODE_NORMAL,
    	EOG_WINDOW_MODE_FULLSCREEN,
    	EOG_WINDOW_MODE_SLIDESHOW
    } EogWindowMode;

### enum EogWindowError

    typedef enum {
    	EOG_WINDOW_ERROR_CONTROL_NOT_FOUND,
    	EOG_WINDOW_ERROR_UI_NOT_FOUND,
    	EOG_WINDOW_ERROR_NO_PERSIST_FILE_INTERFACE,
    	EOG_WINDOW_ERROR_IO,
    	EOG_WINDOW_ERROR_TRASH_NOT_FOUND,
    	EOG_WINDOW_ERROR_GENERIC,
    	EOG_WINDOW_ERROR_UNKNOWN
    } EogWindowError;

### enum EogStartupFlags

    typedef enum {
    	EOG_STARTUP_FULLSCREEN         = 1 << 0,
    	EOG_STARTUP_SLIDE_SHOW         = 1 << 1,
    	EOG_STARTUP_DISABLE_GALLERY    = 1 << 2,
    	EOG_STARTUP_SINGLE_WINDOW      = 1 << 3
    } EogStartupFlags;

### struct EogWindow

    struct EogWindow;

### eog_window_new ()

    GtkWidget *         eog_window_new                      (EogStartupFlags flags);

Creates a new and empty EogWindow. Use `flags` to indicate if the window should be initialized fullscreen, in slideshow mode, and/or without the thumbnails gallery visible. See EogStartupFlags.

`flags` : | the initialization parameters for the new window.
Returns : | a newly created EogWindow.

### eog_window_get_mode ()

    EogWindowMode       eog_window_get_mode                 (EogWindow *window);

Gets the mode of `window`. See EogWindowMode for details.

`window` : | An EogWindow.
Returns : | An EogWindowMode.

### eog_window_set_mode ()

    void                eog_window_set_mode                 (EogWindow *window,
                                                             EogWindowMode mode);

Changes the mode of `window` to normal, fullscreen, or slideshow. See EogWindowMode for details.

`window` : | an EogWindow.
`mode` : | an EogWindowMode value.

### eog_window_get_ui_manager ()

    GtkUIManager *      eog_window_get_ui_manager           (EogWindow *window);

Gets the GtkUIManager that describes the UI of `window`.

`window` : | An EogWindow.
Returns : | A GtkUIManager. [transfer none]

### eog_window_get_store ()

    EogListStore *      eog_window_get_store                (EogWindow *window);

Gets the EogListStore that contains the images in the gallery of `window`.

`window` : | An EogWindow.
Returns : | an EogListStore. [transfer none]

### eog_window_get_view ()

    GtkWidget *         eog_window_get_view                 (EogWindow *window);

Gets the EogScrollView in the window.

`window` : | An EogWindow.
Returns : | the EogScrollView. [transfer none]

### eog_window_get_sidebar ()

    GtkWidget *         eog_window_get_sidebar              (EogWindow *window);

Gets the sidebar widget of `window`.

`window` : | An EogWindow.
Returns : | the EogSidebar. [transfer none]

### eog_window_get_thumb_view ()

    GtkWidget *         eog_window_get_thumb_view           (EogWindow *window);

Gets the thumbnails view in `window`.

`window` : | an EogWindow.
Returns : | an EogThumbView. [transfer none]

### eog_window_get_thumb_nav ()

    GtkWidget *         eog_window_get_thumb_nav            (EogWindow *window);

Gets the thumbnails navigation pane in `window`.

`window` : | an EogWindow.
Returns : | an EogThumbNav. [transfer none]

### eog_window_get_statusbar ()

    GtkWidget *         eog_window_get_statusbar            (EogWindow *window);

Gets the statusbar in `window`.

`window` : | an EogWindow.
Returns : | a EogStatusbar. [transfer none]

### eog_window_get_image ()

    EogImage *          eog_window_get_image                (EogWindow *window);

Gets the image currently displayed in `window` or `NULL` if no image is being displayed.

`window` : | an EogWindow.
Returns : | an EogImage. [transfer none]

### eog_window_open_file_list ()

    void                eog_window_open_file_list           (EogWindow *window,
                                                             GSList *file_list);

Opens a list of files, adding them to the gallery in `window`. Files will be checked to be readable and later filtered according with `eog_list_store_add_files()`.

`window` : | An EogWindow.
`file_list` : | A `NULL`-terminated list of GFile's. [element-type GFile]

### eog_window_is_empty ()

    gboolean            eog_window_is_empty                 (EogWindow *window);

Tells whether `window` is currently empty or not.

`window` : | an EogWindow.
Returns : | `TRUE` if `window` has no images, `FALSE` otherwise.

### eog_window_reload_image ()

    void                eog_window_reload_image             (EogWindow *window);

## Property Details

### The `"gallery-position"` property

      "gallery-position"         EogWindowGalleryPos   : Read / Write

Determines the position of the image gallery in the window relative to the image.

Default value: EOG_WINDOW_GALLERY_POS_BOTTOM

### The `"gallery-resizable"` property

      "gallery-resizable"        gboolean              : Read / Write

If `TRUE` the gallery will be resizable by the user otherwise it will be in single column/row mode.

Default value: FALSE

### The `"startup-flags"` property

      "startup-flags"            EogStartupFlags       : Read / Write / Construct Only

A bitwise OR of EogStartupFlags elements, indicating how the window should behave upon creation.

## Signal Details

### The `"prepared"` signal

    void                user_function                      (EogWindow *window,
                                                            gpointer   user_data)      : Run Last

The "prepared" signal is emitted when the `window` is ready to be shown.

`window` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.