EomWindow

EomWindow

Synopsis

#define             EOM_WINDOW_ERROR
enum                EomWindowMode;
enum                EomWindowError;
enum                EomStartupFlags;
struct              EomWindow;
GtkWidget *         eom_window_new                      (EomStartupFlags flags);
EomWindowMode       eom_window_get_mode                 (EomWindow *window);
void                eom_window_set_mode                 (EomWindow *window,
                                                         EomWindowMode mode);
GtkUIManager *      eom_window_get_ui_manager           (EomWindow *window);
EomListStore *      eom_window_get_store                (EomWindow *window);
GtkWidget *         eom_window_get_view                 (EomWindow *window);
GtkWidget *         eom_window_get_sidebar              (EomWindow *window);
GtkWidget *         eom_window_get_thumb_view           (EomWindow *window);
GtkWidget *         eom_window_get_thumb_nav            (EomWindow *window);
GtkWidget *         eom_window_get_statusbar            (EomWindow *window);
EomImage *          eom_window_get_image                (EomWindow *window);
void                eom_window_open_file_list           (EomWindow *window,
                                                         GSList *file_list);
gboolean            eom_window_is_empty                 (EomWindow *window);

Description

Details

EOM_WINDOW_ERROR

#define EOM_WINDOW_ERROR           (eom_window_error_quark ())


enum EomWindowMode

typedef enum {
	EOM_WINDOW_MODE_UNKNOWN,
	EOM_WINDOW_MODE_NORMAL,
	EOM_WINDOW_MODE_FULLSCREEN,
	EOM_WINDOW_MODE_SLIDESHOW
} EomWindowMode;

EOM_WINDOW_MODE_UNKNOWN

EOM_WINDOW_MODE_NORMAL

EOM_WINDOW_MODE_FULLSCREEN

EOM_WINDOW_MODE_SLIDESHOW


enum EomWindowError

typedef enum {
	EOM_WINDOW_ERROR_CONTROL_NOT_FOUND,
	EOM_WINDOW_ERROR_UI_NOT_FOUND,
	EOM_WINDOW_ERROR_NO_PERSIST_FILE_INTERFACE,
	EOM_WINDOW_ERROR_IO,
	EOM_WINDOW_ERROR_TRASH_NOT_FOUND,
	EOM_WINDOW_ERROR_GENERIC,
	EOM_WINDOW_ERROR_UNKNOWN
} EomWindowError;

EOM_WINDOW_ERROR_CONTROL_NOT_FOUND

EOM_WINDOW_ERROR_UI_NOT_FOUND

EOM_WINDOW_ERROR_NO_PERSIST_FILE_INTERFACE

EOM_WINDOW_ERROR_IO

EOM_WINDOW_ERROR_TRASH_NOT_FOUND

EOM_WINDOW_ERROR_GENERIC

EOM_WINDOW_ERROR_UNKNOWN


enum EomStartupFlags

typedef enum {
	EOM_STARTUP_FULLSCREEN         = 1 << 0,
	EOM_STARTUP_SLIDE_SHOW         = 1 << 1,
	EOM_STARTUP_DISABLE_COLLECTION = 1 << 2
} EomStartupFlags;

EOM_STARTUP_FULLSCREEN

EOM_STARTUP_SLIDE_SHOW

EOM_STARTUP_DISABLE_COLLECTION


struct EomWindow

struct EomWindow {
	GtkWindow win;

	EomWindowPrivate *priv;
};


eom_window_new ()

GtkWidget *         eom_window_new                      (EomStartupFlags flags);

Creates a new and empty EomWindow. Use flags to indicate if the window should be initialized fullscreen, in slideshow mode, and/or without the thumbnails collection visible. See EomStartupFlags.

flags :

the initialization parameters for the new window.

Returns :

a newly created EomWindow.

eom_window_get_mode ()

EomWindowMode       eom_window_get_mode                 (EomWindow *window);

Gets the mode of window. See EomWindowMode for details.

window :

An EomWindow.

Returns :

An EomWindowMode.

eom_window_set_mode ()

void                eom_window_set_mode                 (EomWindow *window,
                                                         EomWindowMode mode);

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

window :

an EomWindow.

mode :

an EomWindowMode value.

eom_window_get_ui_manager ()

GtkUIManager *      eom_window_get_ui_manager           (EomWindow *window);

Gets the GtkUIManager that describes the UI of window.

window :

An EomWindow.

Returns :

A GtkUIManager.

eom_window_get_store ()

EomListStore *      eom_window_get_store                (EomWindow *window);

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

window :

An EomWindow.

Returns :

an EomListStore.

eom_window_get_view ()

GtkWidget *         eom_window_get_view                 (EomWindow *window);

Gets the EomScrollView in the window.

window :

An EomWindow.

Returns :

the EomScrollView.

eom_window_get_sidebar ()

GtkWidget *         eom_window_get_sidebar              (EomWindow *window);

Gets the sidebar widget of window.

window :

An EomWindow.

Returns :

the EomSidebar.

eom_window_get_thumb_view ()

GtkWidget *         eom_window_get_thumb_view           (EomWindow *window);

Gets the thumbnails view in window.

window :

an EomWindow.

Returns :

an EomThumbView.

eom_window_get_thumb_nav ()

GtkWidget *         eom_window_get_thumb_nav            (EomWindow *window);

Gets the thumbnails navigation pane in window.

window :

an EomWindow.

Returns :

an EomThumbNav.

eom_window_get_statusbar ()

GtkWidget *         eom_window_get_statusbar            (EomWindow *window);

Gets the statusbar in window.

window :

an EomWindow.

Returns :

a EomStatusBar.

eom_window_get_image ()

EomImage *          eom_window_get_image                (EomWindow *window);

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

window :

an EomWindow.

Returns :

an EomImage.

eom_window_open_file_list ()

void                eom_window_open_file_list           (EomWindow *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 eom_list_store_add_files().

window :

An EomWindow.

file_list :

A NULL-terminated list of GFile's.

eom_window_is_empty ()

gboolean            eom_window_is_empty                 (EomWindow *window);

Tells whether window is currently empty or not.

window :

an EomWindow.

Returns :

TRUE if window has no images, FALSE otherwise.