EogWindow

EogWindow

Synopsis

#define             EOG_WINDOW_ERROR
enum                EogWindowMode;
enum                EogWindowError;
enum                EogStartupFlags;
                    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);

Object Hierarchy

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

Implemented Interfaces

EogWindow implements AtkImplementorIface and GtkBuildable.

Properties

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

Signals

  "prepared"                                       : Run Last

Description

Details

EOG_WINDOW_ERROR

#define EOG_WINDOW_ERROR           (eog_window_error_quark ())


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_COLLECTION = 1 << 2
} EogStartupFlags;


EogWindow

typedef struct _EogWindow 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 collection 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.

eog_window_get_store ()

EogListStore *      eog_window_get_store                (EogWindow *window);

Gets the EogListStore that contains the images in the collection of window.

window :

An EogWindow.

Returns :

an EogListStore.

eog_window_get_view ()

GtkWidget *         eog_window_get_view                 (EogWindow *window);

Gets the EogScrollView in the window.

window :

An EogWindow.

Returns :

the EogScrollView.

eog_window_get_sidebar ()

GtkWidget *         eog_window_get_sidebar              (EogWindow *window);

Gets the sidebar widget of window.

window :

An EogWindow.

Returns :

the EogSidebar.

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.

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.

eog_window_get_statusbar ()

GtkWidget *         eog_window_get_statusbar            (EogWindow *window);

Gets the statusbar in window.

window :

an EogWindow.

Returns :

a EogStatusBar.

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.

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 collection 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.

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.

Property Details

The "startup-flags" property

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

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

Default value: 0

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.