diff options
Diffstat (limited to 'doc/reference/tmpl')
40 files changed, 4493 insertions, 0 deletions
diff --git a/doc/reference/tmpl/eom-application.sgml b/doc/reference/tmpl/eom-application.sgml new file mode 100644 index 0000000..3d020f7 --- /dev/null +++ b/doc/reference/tmpl/eom-application.sgml @@ -0,0 +1,162 @@ +<!-- ##### SECTION Title ##### --> +EomApplication + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO EOM_APP ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT EomApplication ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION eom_application_get_instance ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_application_register_service ##### --> +<para> + +</para> + +@application: +@Returns: + + +<!-- ##### FUNCTION eom_application_shutdown ##### --> +<para> + +</para> + +@application: + + +<!-- ##### FUNCTION eom_application_open_window ##### --> +<para> + +</para> + +@application: +@timestamp: +@flags: +@error: +@Returns: + + +<!-- ##### FUNCTION eom_application_open_uri_list ##### --> +<para> + +</para> + +@application: +@uri_list: +@timestamp: +@flags: +@error: +@Returns: + + +<!-- ##### FUNCTION eom_application_open_file_list ##### --> +<para> + +</para> + +@application: +@file_list: +@timestamp: +@flags: +@error: +@Returns: + + +<!-- ##### FUNCTION eom_application_open_uris ##### --> +<para> + +</para> + +@application: +@uris: +@timestamp: +@flags: +@error: +@Returns: + + +<!-- ##### FUNCTION eom_application_get_windows ##### --> +<para> + +</para> + +@application: +@Returns: + + +<!-- ##### FUNCTION eom_application_get_toolbars_model ##### --> +<para> + +</para> + +@application: +@Returns: + + +<!-- ##### FUNCTION eom_application_save_toolbars_model ##### --> +<para> + +</para> + +@application: + + +<!-- ##### FUNCTION eom_application_reset_toolbars_model ##### --> +<para> + +</para> + +@app: + + +<!-- ##### FUNCTION eom_application_screensaver_enable ##### --> +<para> + +</para> + +@application: + + +<!-- ##### FUNCTION eom_application_screensaver_disable ##### --> +<para> + +</para> + +@application: + + diff --git a/doc/reference/tmpl/eom-config-keys.sgml b/doc/reference/tmpl/eom-config-keys.sgml new file mode 100644 index 0000000..10db3ea --- /dev/null +++ b/doc/reference/tmpl/eom-config-keys.sgml @@ -0,0 +1,176 @@ +<!-- ##### SECTION Title ##### --> +eom-config-keys + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO EOM_CONF_DIR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_DESKTOP_WALLPAPER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_DESKTOP_CAN_SAVE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_DESKTOP_CAN_PRINT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_DESKTOP_CAN_SETUP_PAGE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_VIEW_INTERPOLATE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_VIEW_SCROLL_WHEEL_ZOOM ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_VIEW_ZOOM_MULTIPLIER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_VIEW_AUTOROTATE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_VIEW_TRANSPARENCY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_VIEW_TRANS_COLOR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_FULLSCREEN_LOOP ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_FULLSCREEN_UPSCALE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_FULLSCREEN_SECONDS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_UI_TOOLBAR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_UI_STATUSBAR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_UI_IMAGE_COLLECTION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_UI_IMAGE_COLLECTION_POSITION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_UI_IMAGE_COLLECTION_RESIZABLE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_UI_SIDEBAR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_UI_SCROLL_BUTTONS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_PLUGINS_ACTIVE_PLUGINS ##### --> +<para> + +</para> + + + diff --git a/doc/reference/tmpl/eom-debug.sgml b/doc/reference/tmpl/eom-debug.sgml new file mode 100644 index 0000000..9a31c92 --- /dev/null +++ b/doc/reference/tmpl/eom-debug.sgml @@ -0,0 +1,157 @@ +<!-- ##### SECTION Title ##### --> +eom-debug + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM EomDebugSection ##### --> +<para> + +</para> + +@EOM_NO_DEBUG: +@EOM_DEBUG_WINDOW: +@EOM_DEBUG_VIEW: +@EOM_DEBUG_JOBS: +@EOM_DEBUG_THUMBNAIL: +@EOM_DEBUG_IMAGE_DATA: +@EOM_DEBUG_IMAGE_LOAD: +@EOM_DEBUG_IMAGE_SAVE: +@EOM_DEBUG_LIST_STORE: +@EOM_DEBUG_PREFERENCES: +@EOM_DEBUG_PRINTING: +@EOM_DEBUG_LCMS: +@EOM_DEBUG_PLUGINS: + +<!-- ##### MACRO DEBUG_WINDOW ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DEBUG_VIEW ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DEBUG_JOBS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DEBUG_THUMBNAIL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DEBUG_IMAGE_DATA ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DEBUG_IMAGE_LOAD ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DEBUG_IMAGE_SAVE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DEBUG_LIST_STORE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DEBUG_PREFERENCES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DEBUG_PRINTING ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DEBUG_LCMS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DEBUG_PLUGINS ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION eom_debug_init ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION eom_debug ##### --> +<para> + +</para> + +@section: +@file: +@line: +@function: + + +<!-- ##### FUNCTION eom_debug_message ##### --> +<para> + +</para> + +@section: +@file: +@line: +@function: +@format: +@Varargs: + + diff --git a/doc/reference/tmpl/eom-dialog.sgml b/doc/reference/tmpl/eom-dialog.sgml new file mode 100644 index 0000000..2f6253b --- /dev/null +++ b/doc/reference/tmpl/eom-dialog.sgml @@ -0,0 +1,69 @@ +<!-- ##### SECTION Title ##### --> +EomDialog + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomDialog ##### --> +<para> + +</para> + + +<!-- ##### ARG EomDialog:parent-window ##### --> +<para> + +</para> + +<!-- ##### FUNCTION eom_dialog_construct ##### --> +<para> + +</para> + +@dialog: +@glade_file: +@dlg_node: + + +<!-- ##### FUNCTION eom_dialog_show ##### --> +<para> + +</para> + +@dialog: + + +<!-- ##### FUNCTION eom_dialog_hide ##### --> +<para> + +</para> + +@dialog: + + +<!-- ##### FUNCTION eom_dialog_get_controls ##### --> +<para> + +</para> + +@dialog: +@property_id: +@Varargs: + + diff --git a/doc/reference/tmpl/eom-error-message-area.sgml b/doc/reference/tmpl/eom-error-message-area.sgml new file mode 100644 index 0000000..e65986f --- /dev/null +++ b/doc/reference/tmpl/eom-error-message-area.sgml @@ -0,0 +1,41 @@ +<!-- ##### SECTION Title ##### --> +eom-error-message-area + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION eom_image_load_error_message_area_new ##### --> +<para> + +</para> + +@caption: +@error: +@Returns: + + +<!-- ##### FUNCTION eom_no_images_error_message_area_new ##### --> +<para> + +</para> + +@file: +@Returns: + + diff --git a/doc/reference/tmpl/eom-exif-details.sgml b/doc/reference/tmpl/eom-exif-details.sgml new file mode 100644 index 0000000..9575f03 --- /dev/null +++ b/doc/reference/tmpl/eom-exif-details.sgml @@ -0,0 +1,55 @@ +<!-- ##### SECTION Title ##### --> +EomExifDetails + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomExifDetails ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION eom_exif_details_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_exif_details_update ##### --> +<para> + +</para> + +@view: +@data: + + +<!-- ##### FUNCTION eom_exif_details_xmp_update ##### --> +<para> + +</para> + +@view: +@xmp_data: + + diff --git a/doc/reference/tmpl/eom-exif-util.sgml b/doc/reference/tmpl/eom-exif-util.sgml new file mode 100644 index 0000000..78f2414 --- /dev/null +++ b/doc/reference/tmpl/eom-exif-util.sgml @@ -0,0 +1,43 @@ +<!-- ##### SECTION Title ##### --> +eom-exif-util + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION eom_exif_util_format_date ##### --> +<para> + +</para> + +@date: +@Returns: + + +<!-- ##### FUNCTION eom_exif_util_get_value ##### --> +<para> + +</para> + +@exif_data: +@tag_id: +@buffer: +@buf_size: +@Returns: + + diff --git a/doc/reference/tmpl/eom-file-chooser.sgml b/doc/reference/tmpl/eom-file-chooser.sgml new file mode 100644 index 0000000..5a12f2f --- /dev/null +++ b/doc/reference/tmpl/eom-file-chooser.sgml @@ -0,0 +1,46 @@ +<!-- ##### SECTION Title ##### --> +EomFileChooser + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomFileChooser ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION eom_file_chooser_new ##### --> +<para> + +</para> + +@action: +@Returns: + + +<!-- ##### FUNCTION eom_file_chooser_get_format ##### --> +<para> + +</para> + +@chooser: +@Returns: + + diff --git a/doc/reference/tmpl/eom-image-save-info.sgml b/doc/reference/tmpl/eom-image-save-info.sgml new file mode 100644 index 0000000..d5ad488 --- /dev/null +++ b/doc/reference/tmpl/eom-image-save-info.sgml @@ -0,0 +1,64 @@ +<!-- ##### SECTION Title ##### --> +EomImageSaveInfo + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomImageSaveInfo ##### --> +<para> + +</para> + + +<!-- ##### MACRO EOM_FILE_FORMAT_JPEG ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION eom_image_save_info_from_image ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION eom_image_save_info_from_uri ##### --> +<para> + +</para> + +@uri: +@format: +@Returns: + + +<!-- ##### FUNCTION eom_image_save_info_from_file ##### --> +<para> + +</para> + +@file: +@format: +@Returns: + + diff --git a/doc/reference/tmpl/eom-image.sgml b/doc/reference/tmpl/eom-image.sgml new file mode 100644 index 0000000..ab270b4 --- /dev/null +++ b/doc/reference/tmpl/eom-image.sgml @@ -0,0 +1,414 @@ +<!-- ##### SECTION Title ##### --> +EomImage + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM EomImageData ##### --> +<para> + +</para> + +@EOM_IMAGE_DATA_IMAGE: +@EOM_IMAGE_DATA_DIMENSION: +@EOM_IMAGE_DATA_EXIF: +@EOM_IMAGE_DATA_XMP: + +<!-- ##### MACRO EOM_IMAGE_DATA_ALL ##### --> +<para> + +</para> + + + +<!-- ##### ENUM EomImageError ##### --> +<para> + +</para> + +@EOM_IMAGE_ERROR_SAVE_NOT_LOCAL: +@EOM_IMAGE_ERROR_NOT_LOADED: +@EOM_IMAGE_ERROR_VFS: +@EOM_IMAGE_ERROR_FILE_EXISTS: +@EOM_IMAGE_ERROR_TMP_FILE_FAILED: +@EOM_IMAGE_ERROR_GENERIC: +@EOM_IMAGE_ERROR_UNKNOWN: + +<!-- ##### MACRO EOM_IMAGE_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### ENUM EomImageStatus ##### --> +<para> + +</para> + +@EOM_IMAGE_STATUS_UNKNOWN: +@EOM_IMAGE_STATUS_LOADING: +@EOM_IMAGE_STATUS_LOADED: +@EOM_IMAGE_STATUS_SAVING: +@EOM_IMAGE_STATUS_FAILED: + +<!-- ##### STRUCT EomImage ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EomImage::changed ##### --> +<para> + +</para> + +@eomimage: the object which received the signal. + +<!-- ##### SIGNAL EomImage::file-changed ##### --> +<para> + +</para> + +@eomimage: the object which received the signal. + +<!-- ##### SIGNAL EomImage::next-frame ##### --> +<para> + +</para> + +@eomimage: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL EomImage::save-progress ##### --> +<para> + +</para> + +@eomimage: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL EomImage::size-prepared ##### --> +<para> + +</para> + +@eomimage: the object which received the signal. +@arg1: +@arg2: + +<!-- ##### SIGNAL EomImage::thumbnail-changed ##### --> +<para> + +</para> + +@eomimage: the object which received the signal. + +<!-- ##### FUNCTION eom_image_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_image_new ##### --> +<para> + +</para> + +@txt_uri: +@Returns: + + +<!-- ##### FUNCTION eom_image_new_file ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION eom_image_load ##### --> +<para> + +</para> + +@img: +@data2read: +@job: +@error: +@Returns: + + +<!-- ##### FUNCTION eom_image_cancel_load ##### --> +<para> + +</para> + +@img: + + +<!-- ##### FUNCTION eom_image_has_data ##### --> +<para> + +</para> + +@img: +@data: +@Returns: + + +<!-- ##### FUNCTION eom_image_data_ref ##### --> +<para> + +</para> + +@img: + + +<!-- ##### FUNCTION eom_image_data_unref ##### --> +<para> + +</para> + +@img: + + +<!-- ##### FUNCTION eom_image_set_thumbnail ##### --> +<para> + +</para> + +@img: +@pixbuf: + + +<!-- ##### FUNCTION eom_image_save_as_by_info ##### --> +<para> + +</para> + +@img: +@source: +@target: +@error: +@Returns: + + +<!-- ##### FUNCTION eom_image_save_by_info ##### --> +<para> + +</para> + +@img: +@source: +@error: +@Returns: + + +<!-- ##### FUNCTION eom_image_get_pixbuf ##### --> +<para> + +</para> + +@img: +@Returns: + + +<!-- ##### FUNCTION eom_image_get_thumbnail ##### --> +<para> + +</para> + +@img: +@Returns: + + +<!-- ##### FUNCTION eom_image_get_size ##### --> +<para> + +</para> + +@img: +@width: +@height: + + +<!-- ##### FUNCTION eom_image_get_bytes ##### --> +<para> + +</para> + +@img: +@Returns: + + +<!-- ##### FUNCTION eom_image_is_modified ##### --> +<para> + +</para> + +@img: +@Returns: + + +<!-- ##### FUNCTION eom_image_modified ##### --> +<para> + +</para> + +@img: + + +<!-- ##### FUNCTION eom_image_get_caption ##### --> +<para> + +</para> + +@img: +@Returns: + + +<!-- ##### FUNCTION eom_image_get_collate_key ##### --> +<para> + +</para> + +@img: +@Returns: + + +<!-- ##### FUNCTION eom_image_get_exif_info ##### --> +<para> + +</para> + +@img: +@Returns: + + +<!-- ##### FUNCTION eom_image_get_xmp_info ##### --> +<para> + +</para> + +@img: +@Returns: + + +<!-- ##### FUNCTION eom_image_get_file ##### --> +<para> + +</para> + +@img: +@Returns: + + +<!-- ##### FUNCTION eom_image_get_uri_for_display ##### --> +<para> + +</para> + +@img: +@Returns: + + +<!-- ##### FUNCTION eom_image_get_status ##### --> +<para> + +</para> + +@img: +@Returns: + + +<!-- ##### FUNCTION eom_image_transform ##### --> +<para> + +</para> + +@img: +@trans: +@job: + + +<!-- ##### FUNCTION eom_image_autorotate ##### --> +<para> + +</para> + +@img: + + +<!-- ##### FUNCTION eom_image_get_profile ##### --> +<para> + +</para> + +@img: +@Returns: + + +<!-- ##### FUNCTION eom_image_apply_display_profile ##### --> +<para> + +</para> + +@img: +@display_profile: + + +<!-- ##### FUNCTION eom_image_undo ##### --> +<para> + +</para> + +@img: + + +<!-- ##### FUNCTION eom_image_get_supported_mime_types ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_image_is_supported_mime_type ##### --> +<para> + +</para> + +@mime_type: +@Returns: + + +<!-- ##### FUNCTION eom_image_file_changed ##### --> +<para> + +</para> + +@img: + + diff --git a/doc/reference/tmpl/eom-job-queue.sgml b/doc/reference/tmpl/eom-job-queue.sgml new file mode 100644 index 0000000..118319b --- /dev/null +++ b/doc/reference/tmpl/eom-job-queue.sgml @@ -0,0 +1,47 @@ +<!-- ##### SECTION Title ##### --> +eom-job-queue + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION eom_job_queue_init ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION eom_job_queue_add_job ##### --> +<para> + +</para> + +@job: + + +<!-- ##### FUNCTION eom_job_queue_remove_job ##### --> +<para> + +</para> + +@job: +@Returns: + + diff --git a/doc/reference/tmpl/eom-jobs.sgml b/doc/reference/tmpl/eom-jobs.sgml new file mode 100644 index 0000000..bf820e2 --- /dev/null +++ b/doc/reference/tmpl/eom-jobs.sgml @@ -0,0 +1,463 @@ +<!-- ##### SECTION Title ##### --> +EomJobCopy + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO EOM_TYPE_JOB_THUMBNAIL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_JOB_THUMBNAIL ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_JOB_THUMBNAIL_CLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO EOM_IS_JOB_THUMBNAIL ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_TYPE_JOB_LOAD ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_JOB_LOAD ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_JOB_LOAD_CLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO EOM_IS_JOB_LOAD ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_TYPE_JOB_MODEL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_JOB_MODEL ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_JOB_MODEL_CLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO EOM_IS_JOB_MODEL ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_TYPE_JOB_TRANSFORM ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_JOB_TRANSFORM ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_JOB_TRANSFORM_CLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO EOM_IS_JOB_TRANSFORM ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_TYPE_JOB_SAVE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_JOB_SAVE ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_JOB_SAVE_CLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO EOM_IS_JOB_SAVE ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_JOB_SAVE_GET_CLASS ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_TYPE_JOB_SAVE_AS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_JOB_SAVE_AS ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_JOB_SAVE_AS_CLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO EOM_IS_JOB_SAVE_AS ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_JOB_COPY ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_JOB_COPY_CLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### STRUCT EomJob ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EomJob::finished ##### --> +<para> + +</para> + +@eomjob: the object which received the signal. + +<!-- ##### SIGNAL EomJob::progress ##### --> +<para> + +</para> + +@eomjob: the object which received the signal. +@arg1: + +<!-- ##### STRUCT EomJobThumbnail ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EomJobLoad ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EomJobModel ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EomJobTransform ##### --> +<para> + +</para> + + +<!-- ##### ENUM EomJobSaveResponse ##### --> +<para> + +</para> + +@EOM_SAVE_RESPONSE_NONE: +@EOM_SAVE_RESPONSE_RETRY: +@EOM_SAVE_RESPONSE_SKIP: +@EOM_SAVE_RESPONSE_OVERWRITE: +@EOM_SAVE_RESPONSE_CANCEL: +@EOM_SAVE_RESPONSE_LAST: + +<!-- ##### STRUCT EomJobSave ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EomJobSaveAs ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EomJobCopy ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION eom_job_finished ##### --> +<para> + +</para> + +@job: + + +<!-- ##### FUNCTION eom_job_run ##### --> +<para> + +</para> + +@job: + + +<!-- ##### FUNCTION eom_job_set_progress ##### --> +<para> + +</para> + +@job: +@progress: + + +<!-- ##### FUNCTION eom_job_thumbnail_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_job_thumbnail_new ##### --> +<para> + +</para> + +@image: +@Returns: + + +<!-- ##### FUNCTION eom_job_load_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_job_load_new ##### --> +<para> + +</para> + +@image: +@data: +@Returns: + + +<!-- ##### FUNCTION eom_job_model_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_job_model_new ##### --> +<para> + +</para> + +@file_list: +@Returns: + + +<!-- ##### FUNCTION eom_job_transform_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_job_transform_new ##### --> +<para> + +</para> + +@images: +@trans: +@Returns: + + +<!-- ##### FUNCTION eom_job_save_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_job_save_new ##### --> +<para> + +</para> + +@images: +@Returns: + + +<!-- ##### FUNCTION eom_job_save_as_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_job_save_as_new ##### --> +<para> + +</para> + +@images: +@converter: +@file: +@Returns: + + +<!-- ##### FUNCTION eom_job_copy_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_job_copy_new ##### --> +<para> + +</para> + +@images: +@dest: +@Returns: + + diff --git a/doc/reference/tmpl/eom-list-store.sgml b/doc/reference/tmpl/eom-list-store.sgml new file mode 100644 index 0000000..6241cd4 --- /dev/null +++ b/doc/reference/tmpl/eom-list-store.sgml @@ -0,0 +1,166 @@ +<!-- ##### SECTION Title ##### --> +EomListStore + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO EOM_LIST_STORE_THUMB_SIZE ##### --> +<para> + +</para> + + + +<!-- ##### ENUM EomListStoreColumn ##### --> +<para> + +</para> + +@EOM_LIST_STORE_THUMBNAIL: +@EOM_LIST_STORE_THUMB_SET: +@EOM_LIST_STORE_EOM_IMAGE: +@EOM_LIST_STORE_EOM_JOB: +@EOM_LIST_STORE_NUM_COLUMNS: + +<!-- ##### STRUCT EomListStore ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION eom_list_store_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_list_store_new_from_glist ##### --> +<para> + +</para> + +@list: +@Returns: + + +<!-- ##### FUNCTION eom_list_store_append_image ##### --> +<para> + +</para> + +@store: +@image: + + +<!-- ##### FUNCTION eom_list_store_add_files ##### --> +<para> + +</para> + +@store: +@file_list: + + +<!-- ##### FUNCTION eom_list_store_remove_image ##### --> +<para> + +</para> + +@store: +@image: + + +<!-- ##### FUNCTION eom_list_store_get_pos_by_image ##### --> +<para> + +</para> + +@store: +@image: +@Returns: + + +<!-- ##### FUNCTION eom_list_store_get_image_by_pos ##### --> +<para> + +</para> + +@store: +@pos: +@Returns: + + +<!-- ##### FUNCTION eom_list_store_get_pos_by_iter ##### --> +<para> + +</para> + +@store: +@iter: +@Returns: + + +<!-- ##### FUNCTION eom_list_store_length ##### --> +<para> + +</para> + +@store: +@Returns: + + +<!-- ##### FUNCTION eom_list_store_get_initial_pos ##### --> +<para> + +</para> + +@store: +@Returns: + + +<!-- ##### FUNCTION eom_list_store_thumbnail_set ##### --> +<para> + +</para> + +@store: +@iter: + + +<!-- ##### FUNCTION eom_list_store_thumbnail_unset ##### --> +<para> + +</para> + +@store: +@iter: + + +<!-- ##### FUNCTION eom_list_store_thumbnail_refresh ##### --> +<para> + +</para> + +@store: +@iter: + + diff --git a/doc/reference/tmpl/eom-metadata-reader-jpg.sgml b/doc/reference/tmpl/eom-metadata-reader-jpg.sgml new file mode 100644 index 0000000..124e54e --- /dev/null +++ b/doc/reference/tmpl/eom-metadata-reader-jpg.sgml @@ -0,0 +1,28 @@ +<!-- ##### SECTION Title ##### --> +EomMetadataReaderJpg + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomMetadataReaderJpg ##### --> +<para> + +</para> + + diff --git a/doc/reference/tmpl/eom-metadata-reader-png.sgml b/doc/reference/tmpl/eom-metadata-reader-png.sgml new file mode 100644 index 0000000..74d2df3 --- /dev/null +++ b/doc/reference/tmpl/eom-metadata-reader-png.sgml @@ -0,0 +1,28 @@ +<!-- ##### SECTION Title ##### --> +EomMetadataReaderPng + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomMetadataReaderPng ##### --> +<para> + +</para> + + diff --git a/doc/reference/tmpl/eom-metadata-reader.sgml b/doc/reference/tmpl/eom-metadata-reader.sgml new file mode 100644 index 0000000..d44ad0a --- /dev/null +++ b/doc/reference/tmpl/eom-metadata-reader.sgml @@ -0,0 +1,140 @@ +<!-- ##### SECTION Title ##### --> +eom-metadata-reader + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO EOM_METADATA_READER_GET_INTERFACE ##### --> +<para> + +</para> + +@o: + + +<!-- ##### STRUCT EomMetadataReader ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EomMetadataReaderInterface ##### --> +<para> + +</para> + +@parent: +@consume: +@finished: +@get_raw_exif: +@get_exif_data: +@get_icc_profile: +@get_xmp_ptr: + +<!-- ##### ENUM EomMetadataFileType ##### --> +<para> + +</para> + +@EOM_METADATA_JPEG: +@EOM_METADATA_PNG: + +<!-- ##### FUNCTION eom_metadata_reader_new ##### --> +<para> + +</para> + +@type: +@Returns: + + +<!-- ##### FUNCTION eom_metadata_reader_consume ##### --> +<para> + +</para> + +@emr: +@buf: +@len: + + +<!-- ##### FUNCTION eom_metadata_reader_finished ##### --> +<para> + +</para> + +@emr: +@Returns: + + +<!-- ##### FUNCTION eom_metadata_reader_get_exif_chunk ##### --> +<para> + +</para> + +@emr: +@data: +@len: + + +<!-- ##### FUNCTION eom_metadata_reader_get_exif_data ##### --> +<para> + +</para> + +@emr: +@Returns: + + +<!-- ##### FUNCTION eom_metadata_reader_get_xmp_data ##### --> +<para> + +</para> + +@emr: +@Returns: + + +<!-- ##### FUNCTION eom_metadata_reader_get_iptc_chunk ##### --> +<para> + +</para> + +@emr: +@Returns: + + +<!-- ##### FUNCTION eom_metadata_reader_get_iptc_data ##### --> +<para> + +</para> + +@emr: +@Returns: + + +<!-- ##### FUNCTION eom_metadata_reader_get_icc_profile ##### --> +<para> + +</para> + +@emr: +@Returns: + + diff --git a/doc/reference/tmpl/eom-pixbuf-util.sgml b/doc/reference/tmpl/eom-pixbuf-util.sgml new file mode 100644 index 0000000..4ea3683 --- /dev/null +++ b/doc/reference/tmpl/eom-pixbuf-util.sgml @@ -0,0 +1,58 @@ +<!-- ##### SECTION Title ##### --> +eom-pixbuf-util + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION eom_pixbuf_get_savable_formats ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_pixbuf_get_format_by_suffix ##### --> +<para> + +</para> + +@suffix: +@Returns: + + +<!-- ##### FUNCTION eom_pixbuf_get_format ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION eom_pixbuf_get_common_suffix ##### --> +<para> + +</para> + +@format: +@Returns: + + diff --git a/doc/reference/tmpl/eom-plugin-engine.sgml b/doc/reference/tmpl/eom-plugin-engine.sgml new file mode 100644 index 0000000..fbc88cf --- /dev/null +++ b/doc/reference/tmpl/eom-plugin-engine.sgml @@ -0,0 +1,179 @@ +<!-- ##### SECTION Title ##### --> +eom-plugin-engine + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomPluginInfo ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION eom_plugin_engine_init ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_engine_shutdown ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION eom_plugin_engine_garbage_collect ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION eom_plugin_engine_get_plugins_list ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_engine_activate_plugin ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_engine_deactivate_plugin ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_engine_plugin_is_active ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_engine_plugin_is_available ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_engine_plugin_is_configurable ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_engine_configure_plugin ##### --> +<para> + +</para> + +@info: +@parent: + + +<!-- ##### FUNCTION eom_plugin_engine_update_plugins_ui ##### --> +<para> + +</para> + +@window: +@new_window: + + +<!-- ##### FUNCTION eom_plugin_engine_get_plugin_name ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_engine_get_plugin_description ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_engine_get_plugin_icon_name ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_engine_get_plugin_authors ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_engine_get_plugin_website ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_engine_get_plugin_copyright ##### --> +<para> + +</para> + +@info: +@Returns: + + diff --git a/doc/reference/tmpl/eom-plugin-manager.sgml b/doc/reference/tmpl/eom-plugin-manager.sgml new file mode 100644 index 0000000..c6331f5 --- /dev/null +++ b/doc/reference/tmpl/eom-plugin-manager.sgml @@ -0,0 +1,37 @@ +<!-- ##### SECTION Title ##### --> +EomPluginManager + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomPluginManager ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION eom_plugin_manager_new ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/doc/reference/tmpl/eom-plugin.sgml b/doc/reference/tmpl/eom-plugin.sgml new file mode 100644 index 0000000..ece85ef --- /dev/null +++ b/doc/reference/tmpl/eom-plugin.sgml @@ -0,0 +1,121 @@ +<!-- ##### SECTION Title ##### --> +EomPlugin + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO EOM_PLUGIN_CONST ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### STRUCT EomPlugin ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION eom_plugin_activate ##### --> +<para> + +</para> + +@plugin: +@window: + + +<!-- ##### FUNCTION eom_plugin_deactivate ##### --> +<para> + +</para> + +@plugin: +@window: + + +<!-- ##### FUNCTION eom_plugin_update_ui ##### --> +<para> + +</para> + +@plugin: +@window: + + +<!-- ##### FUNCTION eom_plugin_is_configurable ##### --> +<para> + +</para> + +@plugin: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_create_configure_dialog ##### --> +<para> + +</para> + +@plugin: +@Returns: + + +<!-- ##### MACRO EOM_PLUGIN_REGISTER_TYPE_WITH_CODE ##### --> +<para> + +</para> + +@PluginName: +@plugin_name: +@CODE: + + +<!-- ##### MACRO EOM_PLUGIN_REGISTER_TYPE ##### --> +<para> + +</para> + +@PluginName: +@plugin_name: + + +<!-- ##### MACRO EOM_PLUGIN_DEFINE_TYPE_WITH_CODE ##### --> +<para> + +</para> + +@ObjectName: +@object_name: +@PARENT_TYPE: +@CODE: + + +<!-- ##### MACRO EOM_PLUGIN_DEFINE_TYPE ##### --> +<para> + +</para> + +@ObjectName: +@object_name: +@PARENT_TYPE: + + diff --git a/doc/reference/tmpl/eom-preferences-dialog.sgml b/doc/reference/tmpl/eom-preferences-dialog.sgml new file mode 100644 index 0000000..1199d1a --- /dev/null +++ b/doc/reference/tmpl/eom-preferences-dialog.sgml @@ -0,0 +1,43 @@ +<!-- ##### SECTION Title ##### --> +EomPreferencesDialog + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomPreferencesDialog ##### --> +<para> + +</para> + + +<!-- ##### ARG EomPreferencesDialog:mateconf-client ##### --> +<para> + +</para> + +<!-- ##### FUNCTION eom_preferences_dialog_get_instance ##### --> +<para> + +</para> + +@parent: +@client: +@Returns: + + diff --git a/doc/reference/tmpl/eom-print-image-setup.sgml b/doc/reference/tmpl/eom-print-image-setup.sgml new file mode 100644 index 0000000..3f938ca --- /dev/null +++ b/doc/reference/tmpl/eom-print-image-setup.sgml @@ -0,0 +1,60 @@ +<!-- ##### SECTION Title ##### --> +EomPrintImageSetup + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomPrintImageSetup ##### --> +<para> + +</para> + + +<!-- ##### ARG EomPrintImageSetup:image ##### --> +<para> + +</para> + +<!-- ##### ARG EomPrintImageSetup:page-setup ##### --> +<para> + +</para> + +<!-- ##### FUNCTION eom_print_image_setup_new ##### --> +<para> + +</para> + +@image: +@page_setup: +@Returns: + + +<!-- ##### FUNCTION eom_print_image_setup_get_options ##### --> +<para> + +</para> + +@setup: +@left: +@top: +@scale: +@unit: + + diff --git a/doc/reference/tmpl/eom-print-preview.sgml b/doc/reference/tmpl/eom-print-preview.sgml new file mode 100644 index 0000000..1dbb584 --- /dev/null +++ b/doc/reference/tmpl/eom-print-preview.sgml @@ -0,0 +1,153 @@ +<!-- ##### SECTION Title ##### --> +EomPrintPreview + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomPrintPreview ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EomPrintPreview::image-moved ##### --> +<para> + +</para> + +@eomprintpreview: the object which received the signal. + +<!-- ##### ARG EomPrintPreview:image ##### --> +<para> + +</para> + +<!-- ##### ARG EomPrintPreview:image-scale ##### --> +<para> + +</para> + +<!-- ##### ARG EomPrintPreview:image-x-align ##### --> +<para> + +</para> + +<!-- ##### ARG EomPrintPreview:image-y-align ##### --> +<para> + +</para> + +<!-- ##### ARG EomPrintPreview:page-bottom-margin ##### --> +<para> + +</para> + +<!-- ##### ARG EomPrintPreview:page-left-margin ##### --> +<para> + +</para> + +<!-- ##### ARG EomPrintPreview:page-right-margin ##### --> +<para> + +</para> + +<!-- ##### ARG EomPrintPreview:page-top-margin ##### --> +<para> + +</para> + +<!-- ##### ARG EomPrintPreview:paper-height ##### --> +<para> + +</para> + +<!-- ##### ARG EomPrintPreview:paper-width ##### --> +<para> + +</para> + +<!-- ##### FUNCTION eom_print_preview_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_print_preview_new_with_pixbuf ##### --> +<para> + +</para> + +@pixbuf: +@Returns: + + +<!-- ##### FUNCTION eom_print_preview_set_page_margins ##### --> +<para> + +</para> + +@preview: +@l_margin: +@r_margin: +@t_margin: +@b_margin: + + +<!-- ##### FUNCTION eom_print_preview_set_from_page_setup ##### --> +<para> + +</para> + +@preview: +@setup: + + +<!-- ##### FUNCTION eom_print_preview_get_image_position ##### --> +<para> + +</para> + +@preview: +@x: +@y: + + +<!-- ##### FUNCTION eom_print_preview_set_image_position ##### --> +<para> + +</para> + +@preview: +@x: +@y: + + +<!-- ##### FUNCTION eom_print_preview_set_scale ##### --> +<para> + +</para> + +@preview: +@scale: + + diff --git a/doc/reference/tmpl/eom-print.sgml b/doc/reference/tmpl/eom-print.sgml new file mode 100644 index 0000000..c717c75 --- /dev/null +++ b/doc/reference/tmpl/eom-print.sgml @@ -0,0 +1,67 @@ +<!-- ##### SECTION Title ##### --> +eom-print + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION eom_print_operation_new ##### --> +<para> + +</para> + +@image: +@print_settings: +@page_setup: +@Returns: + + +<!-- ##### FUNCTION eom_print_get_page_setup ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_print_set_page_setup ##### --> +<para> + +</para> + +@page_setup: + + +<!-- ##### FUNCTION eom_print_get_print_settings ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_print_set_print_settings ##### --> +<para> + +</para> + +@print_settings: + + diff --git a/doc/reference/tmpl/eom-properties-dialog.sgml b/doc/reference/tmpl/eom-properties-dialog.sgml new file mode 100644 index 0000000..b6b4d23 --- /dev/null +++ b/doc/reference/tmpl/eom-properties-dialog.sgml @@ -0,0 +1,78 @@ +<!-- ##### SECTION Title ##### --> +EomPropertiesDialog + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM EomPropertiesDialogPage ##### --> +<para> + +</para> + +@EOM_PROPERTIES_DIALOG_PAGE_GENERAL: +@EOM_PROPERTIES_DIALOG_PAGE_EXIF: +@EOM_PROPERTIES_DIALOG_PAGE_DETAILS: +@EOM_PROPERTIES_DIALOG_N_PAGES: + +<!-- ##### STRUCT EomPropertiesDialog ##### --> +<para> + +</para> + + +<!-- ##### ARG EomPropertiesDialog:netbook-mode ##### --> +<para> + +</para> + +<!-- ##### ARG EomPropertiesDialog:thumbview ##### --> +<para> + +</para> + +<!-- ##### FUNCTION eom_properties_dialog_new ##### --> +<para> + +</para> + +@parent: +@thumbview: +@next_image_action: +@previous_image_action: +@Returns: + + +<!-- ##### FUNCTION eom_properties_dialog_update ##### --> +<para> + +</para> + +@prop: +@image: + + +<!-- ##### FUNCTION eom_properties_dialog_set_page ##### --> +<para> + +</para> + +@prop: +@page: + + diff --git a/doc/reference/tmpl/eom-save-as-dialog-helper.sgml b/doc/reference/tmpl/eom-save-as-dialog-helper.sgml new file mode 100644 index 0000000..72a2e79 --- /dev/null +++ b/doc/reference/tmpl/eom-save-as-dialog-helper.sgml @@ -0,0 +1,42 @@ +<!-- ##### SECTION Title ##### --> +eom-save-as-dialog-helper + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION eom_save_as_dialog_new ##### --> +<para> + +</para> + +@main: +@images: +@base_file: +@Returns: + + +<!-- ##### FUNCTION eom_save_as_dialog_get_converter ##### --> +<para> + +</para> + +@dlg: +@Returns: + + diff --git a/doc/reference/tmpl/eom-scroll-view.sgml b/doc/reference/tmpl/eom-scroll-view.sgml new file mode 100644 index 0000000..c832585 --- /dev/null +++ b/doc/reference/tmpl/eom-scroll-view.sgml @@ -0,0 +1,224 @@ +<!-- ##### SECTION Title ##### --> +EomScrollView + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomScrollView ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EomScrollView::zoom-changed ##### --> +<para> + +</para> + +@eomscrollview: the object which received the signal. +@arg1: + +<!-- ##### ARG EomScrollView:background-color ##### --> +<para> + +</para> + +<!-- ##### ARG EomScrollView:use-background-color ##### --> +<para> + +</para> + +<!-- ##### ENUM EomTransparencyStyle ##### --> +<para> + +</para> + +@EOM_TRANSP_BACKGROUND: +@EOM_TRANSP_CHECKED: +@EOM_TRANSP_COLOR: + +<!-- ##### FUNCTION eom_scroll_view_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_scroll_view_set_image ##### --> +<para> + +</para> + +@view: +@image: + + +<!-- ##### FUNCTION eom_scroll_view_set_scroll_wheel_zoom ##### --> +<para> + +</para> + +@view: +@scroll_wheel_zoom: + + +<!-- ##### FUNCTION eom_scroll_view_set_zoom_upscale ##### --> +<para> + +</para> + +@view: +@upscale: + + +<!-- ##### FUNCTION eom_scroll_view_set_zoom_multiplier ##### --> +<para> + +</para> + +@view: +@multiplier: + + +<!-- ##### FUNCTION eom_scroll_view_set_antialiasing_in ##### --> +<para> + +</para> + +@view: +@state: + + +<!-- ##### FUNCTION eom_scroll_view_set_antialiasing_out ##### --> +<para> + +</para> + +@view: +@state: + + +<!-- ##### FUNCTION eom_scroll_view_set_transparency ##### --> +<para> + +</para> + +@view: +@style: +@color: + + +<!-- ##### FUNCTION eom_scroll_view_scrollbars_visible ##### --> +<para> + +</para> + +@view: +@Returns: + + +<!-- ##### FUNCTION eom_scroll_view_set_popup ##### --> +<para> + +</para> + +@view: +@menu: + + +<!-- ##### FUNCTION eom_scroll_view_zoom_in ##### --> +<para> + +</para> + +@view: +@smooth: + + +<!-- ##### FUNCTION eom_scroll_view_zoom_out ##### --> +<para> + +</para> + +@view: +@smooth: + + +<!-- ##### FUNCTION eom_scroll_view_zoom_fit ##### --> +<para> + +</para> + +@view: + + +<!-- ##### FUNCTION eom_scroll_view_set_zoom ##### --> +<para> + +</para> + +@view: +@zoom: + + +<!-- ##### FUNCTION eom_scroll_view_get_zoom ##### --> +<para> + +</para> + +@view: +@Returns: + + +<!-- ##### FUNCTION eom_scroll_view_get_zoom_is_min ##### --> +<para> + +</para> + +@view: +@Returns: + + +<!-- ##### FUNCTION eom_scroll_view_get_zoom_is_max ##### --> +<para> + +</para> + +@view: +@Returns: + + +<!-- ##### FUNCTION eom_scroll_view_show_cursor ##### --> +<para> + +</para> + +@view: + + +<!-- ##### FUNCTION eom_scroll_view_hide_cursor ##### --> +<para> + +</para> + +@view: + + diff --git a/doc/reference/tmpl/eom-session.sgml b/doc/reference/tmpl/eom-session.sgml new file mode 100644 index 0000000..3c785c2 --- /dev/null +++ b/doc/reference/tmpl/eom-session.sgml @@ -0,0 +1,48 @@ +<!-- ##### SECTION Title ##### --> +eom-session + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION eom_session_init ##### --> +<para> + +</para> + +@application: + + +<!-- ##### FUNCTION eom_session_is_restored ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_session_load ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/doc/reference/tmpl/eom-sidebar.sgml b/doc/reference/tmpl/eom-sidebar.sgml new file mode 100644 index 0000000..ff8fa46 --- /dev/null +++ b/doc/reference/tmpl/eom-sidebar.sgml @@ -0,0 +1,104 @@ +<!-- ##### SECTION Title ##### --> +EomSidebar + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomSidebar ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EomSidebar::page-added ##### --> +<para> + +</para> + +@eomsidebar: the object which received the signal. +@widget: + +<!-- ##### SIGNAL EomSidebar::page-removed ##### --> +<para> + +</para> + +@eomsidebar: the object which received the signal. +@widget: + +<!-- ##### ARG EomSidebar:current-page ##### --> +<para> + +</para> + +<!-- ##### FUNCTION eom_sidebar_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_sidebar_add_page ##### --> +<para> + +</para> + +@eom_sidebar: +@title: +@main_widget: + + +<!-- ##### FUNCTION eom_sidebar_remove_page ##### --> +<para> + +</para> + +@eom_sidebar: +@main_widget: + + +<!-- ##### FUNCTION eom_sidebar_set_page ##### --> +<para> + +</para> + +@eom_sidebar: +@main_widget: + + +<!-- ##### FUNCTION eom_sidebar_get_n_pages ##### --> +<para> + +</para> + +@eom_sidebar: +@Returns: + + +<!-- ##### FUNCTION eom_sidebar_is_empty ##### --> +<para> + +</para> + +@eom_sidebar: +@Returns: + + diff --git a/doc/reference/tmpl/eom-statusbar.sgml b/doc/reference/tmpl/eom-statusbar.sgml new file mode 100644 index 0000000..b5b6fe9 --- /dev/null +++ b/doc/reference/tmpl/eom-statusbar.sgml @@ -0,0 +1,65 @@ +<!-- ##### SECTION Title ##### --> +EomStatusbar + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomStatusbar ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION eom_statusbar_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_statusbar_set_image_number ##### --> +<para> + +</para> + +@statusbar: +@num: +@tot: + + +<!-- ##### FUNCTION eom_statusbar_set_progress ##### --> +<para> + +</para> + +@statusbar: +@progress: + + +<!-- ##### FUNCTION eom_statusbar_set_has_resize_grip ##### --> +<para> + +</para> + +@statusbar: +@has_resize_grip: + + diff --git a/doc/reference/tmpl/eom-thumb-nav.sgml b/doc/reference/tmpl/eom-thumb-nav.sgml new file mode 100644 index 0000000..f08c5cb --- /dev/null +++ b/doc/reference/tmpl/eom-thumb-nav.sgml @@ -0,0 +1,100 @@ +<!-- ##### SECTION Title ##### --> +EomThumbNav + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM EomThumbNavMode ##### --> +<para> + +</para> + +@EOM_THUMB_NAV_MODE_ONE_ROW: +@EOM_THUMB_NAV_MODE_ONE_COLUMN: +@EOM_THUMB_NAV_MODE_MULTIPLE_ROWS: +@EOM_THUMB_NAV_MODE_MULTIPLE_COLUMNS: + +<!-- ##### STRUCT EomThumbNav ##### --> +<para> + +</para> + + +<!-- ##### ARG EomThumbNav:mode ##### --> +<para> + +</para> + +<!-- ##### ARG EomThumbNav:show-buttons ##### --> +<para> + +</para> + +<!-- ##### ARG EomThumbNav:thumbview ##### --> +<para> + +</para> + +<!-- ##### FUNCTION eom_thumb_nav_new ##### --> +<para> + +</para> + +@thumbview: +@mode: +@show_buttons: +@Returns: + + +<!-- ##### FUNCTION eom_thumb_nav_get_show_buttons ##### --> +<para> + +</para> + +@nav: +@Returns: + + +<!-- ##### FUNCTION eom_thumb_nav_set_show_buttons ##### --> +<para> + +</para> + +@nav: +@show_buttons: + + +<!-- ##### FUNCTION eom_thumb_nav_get_mode ##### --> +<para> + +</para> + +@nav: +@Returns: + + +<!-- ##### FUNCTION eom_thumb_nav_set_mode ##### --> +<para> + +</para> + +@nav: +@mode: + + diff --git a/doc/reference/tmpl/eom-thumb-view.sgml b/doc/reference/tmpl/eom-thumb-view.sgml new file mode 100644 index 0000000..c63d124 --- /dev/null +++ b/doc/reference/tmpl/eom-thumb-view.sgml @@ -0,0 +1,122 @@ +<!-- ##### SECTION Title ##### --> +EomThumbView + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM EomThumbViewSelectionChange ##### --> +<para> + +</para> + +@EOM_THUMB_VIEW_SELECT_CURRENT: +@EOM_THUMB_VIEW_SELECT_LEFT: +@EOM_THUMB_VIEW_SELECT_RIGHT: +@EOM_THUMB_VIEW_SELECT_FIRST: +@EOM_THUMB_VIEW_SELECT_LAST: +@EOM_THUMB_VIEW_SELECT_RANDOM: + +<!-- ##### STRUCT EomThumbView ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION eom_thumb_view_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_thumb_view_set_model ##### --> +<para> + +</para> + +@thumbview: +@store: + + +<!-- ##### FUNCTION eom_thumb_view_set_item_height ##### --> +<para> + +</para> + +@thumbview: +@height: + + +<!-- ##### FUNCTION eom_thumb_view_get_n_selected ##### --> +<para> + +</para> + +@thumbview: +@Returns: + + +<!-- ##### FUNCTION eom_thumb_view_get_first_selected_image ##### --> +<para> + +</para> + +@thumbview: +@Returns: + + +<!-- ##### FUNCTION eom_thumb_view_get_selected_images ##### --> +<para> + +</para> + +@thumbview: +@Returns: + + +<!-- ##### FUNCTION eom_thumb_view_select_single ##### --> +<para> + +</para> + +@thumbview: +@change: + + +<!-- ##### FUNCTION eom_thumb_view_set_current_image ##### --> +<para> + +</para> + +@thumbview: +@image: +@deselect_other: + + +<!-- ##### FUNCTION eom_thumb_view_set_thumbnail_popup ##### --> +<para> + +</para> + +@thumbview: +@menu: + + diff --git a/doc/reference/tmpl/eom-thumbnail.sgml b/doc/reference/tmpl/eom-thumbnail.sgml new file mode 100644 index 0000000..2de9aea --- /dev/null +++ b/doc/reference/tmpl/eom-thumbnail.sgml @@ -0,0 +1,73 @@ +<!-- ##### SECTION Title ##### --> +eom-thumbnail + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION eom_thumbnail_init ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION eom_thumbnail_fit_to_size ##### --> +<para> + +</para> + +@thumbnail: +@dimension: +@Returns: + + +<!-- ##### FUNCTION eom_thumbnail_add_frame ##### --> +<para> + +</para> + +@thumbnail: +@Returns: + + +<!-- ##### FUNCTION eom_thumbnail_load ##### --> +<para> + +</para> + +@image: +@error: +@Returns: + + +<!-- ##### MACRO EOM_THUMBNAIL_ORIGINAL_WIDTH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_THUMBNAIL_ORIGINAL_HEIGHT ##### --> +<para> + +</para> + + + diff --git a/doc/reference/tmpl/eom-transform.sgml b/doc/reference/tmpl/eom-transform.sgml new file mode 100644 index 0000000..effa3a2 --- /dev/null +++ b/doc/reference/tmpl/eom-transform.sgml @@ -0,0 +1,136 @@ +<!-- ##### SECTION Title ##### --> +EomTransform + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM EomTransformType ##### --> +<para> + +</para> + +@EOM_TRANSFORM_NONE: +@EOM_TRANSFORM_ROT_90: +@EOM_TRANSFORM_ROT_180: +@EOM_TRANSFORM_ROT_270: +@EOM_TRANSFORM_FLIP_HORIZONTAL: +@EOM_TRANSFORM_FLIP_VERTICAL: +@EOM_TRANSFORM_TRANSPOSE: +@EOM_TRANSFORM_TRANSVERSE: + +<!-- ##### STRUCT EomTransform ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION eom_transform_apply ##### --> +<para> + +</para> + +@trans: +@pixbuf: +@job: +@Returns: + + +<!-- ##### FUNCTION eom_transform_reverse ##### --> +<para> + +</para> + +@trans: +@Returns: + + +<!-- ##### FUNCTION eom_transform_compose ##### --> +<para> + +</para> + +@trans: +@compose: +@Returns: + + +<!-- ##### FUNCTION eom_transform_is_identity ##### --> +<para> + +</para> + +@trans: +@Returns: + + +<!-- ##### FUNCTION eom_transform_identity_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_transform_rotate_new ##### --> +<para> + +</para> + +@degree: +@Returns: + + +<!-- ##### FUNCTION eom_transform_flip_new ##### --> +<para> + +</para> + +@type: +@Returns: + + +<!-- ##### FUNCTION eom_transform_scale_new ##### --> +<para> + +</para> + +@sx: +@sy: +@Returns: + + +<!-- ##### FUNCTION eom_transform_new ##### --> +<para> + +</para> + +@trans: +@Returns: + + +<!-- ##### FUNCTION eom_transform_get_transform_type ##### --> +<para> + +</para> + +@trans: +@Returns: + + diff --git a/doc/reference/tmpl/eom-unused.sgml b/doc/reference/tmpl/eom-unused.sgml new file mode 100644 index 0000000..43a0f33 --- /dev/null +++ b/doc/reference/tmpl/eom-unused.sgml @@ -0,0 +1,66 @@ +<!-- ##### ARG EomScrollView:antialiasing-in ##### --> +<para> + +</para> + + +<!-- ##### ARG EomScrollView:antialiasing-out ##### --> +<para> + +</para> + + +<!-- ##### ARG EomScrollView:default-bg-color ##### --> +<para> + +</para> + + +<!-- ##### ARG EomScrollView:maximum-image-scale ##### --> +<para> + +</para> + + +<!-- ##### ARG EomScrollView:scrollwheel-zoom ##### --> +<para> + +</para> + + +<!-- ##### ARG EomScrollView:transparency ##### --> +<para> + +</para> + + +<!-- ##### ARG EomScrollView:transparency-color ##### --> +<para> + +</para> + + +<!-- ##### ARG EomScrollView:transparency-style ##### --> +<para> + +</para> + + +<!-- ##### ARG EomScrollView:zoom-multiplier ##### --> +<para> + +</para> + + +<!-- ##### ARG EomWindow:gallery-position ##### --> +<para> + +</para> + + +<!-- ##### ARG EomWindow:gallery-resizable ##### --> +<para> + +</para> + + diff --git a/doc/reference/tmpl/eom-uri-converter.sgml b/doc/reference/tmpl/eom-uri-converter.sgml new file mode 100644 index 0000000..2333152 --- /dev/null +++ b/doc/reference/tmpl/eom-uri-converter.sgml @@ -0,0 +1,174 @@ +<!-- ##### SECTION Title ##### --> +EomURIConverter + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM EomUCType ##### --> +<para> + +</para> + +@EOM_UC_STRING: +@EOM_UC_FILENAME: +@EOM_UC_COUNTER: +@EOM_UC_COMMENT: +@EOM_UC_DATE: +@EOM_UC_TIME: +@EOM_UC_DAY: +@EOM_UC_MONTH: +@EOM_UC_YEAR: +@EOM_UC_HOUR: +@EOM_UC_MINUTE: +@EOM_UC_SECOND: +@EOM_UC_END: + +<!-- ##### STRUCT EomUCInfo ##### --> +<para> + +</para> + +@description: +@rep: +@req_exif: + +<!-- ##### ENUM EomUCError ##### --> +<para> + +</para> + +@EOM_UC_ERROR_INVALID_UNICODE: +@EOM_UC_ERROR_INVALID_CHARACTER: +@EOM_UC_ERROR_EQUAL_FILENAMES: +@EOM_UC_ERROR_UNKNOWN: + +<!-- ##### MACRO EOM_UC_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT EomURIConverter ##### --> +<para> + +</para> + + +<!-- ##### ARG EomURIConverter:convert-spaces ##### --> +<para> + +</para> + +<!-- ##### ARG EomURIConverter:counter-n-digits ##### --> +<para> + +</para> + +<!-- ##### ARG EomURIConverter:counter-start ##### --> +<para> + +</para> + +<!-- ##### ARG EomURIConverter:n-images ##### --> +<para> + +</para> + +<!-- ##### ARG EomURIConverter:space-character ##### --> +<para> + +</para> + +<!-- ##### FUNCTION eom_uc_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_uri_converter_new ##### --> +<para> + +</para> + +@base_file: +@img_format: +@format_string: +@Returns: + + +<!-- ##### FUNCTION eom_uri_converter_check ##### --> +<para> + +</para> + +@converter: +@img_list: +@error: +@Returns: + + +<!-- ##### FUNCTION eom_uri_converter_requires_exif ##### --> +<para> + +</para> + +@converter: +@Returns: + + +<!-- ##### FUNCTION eom_uri_converter_do ##### --> +<para> + +</para> + +@converter: +@image: +@file: +@format: +@error: +@Returns: + + +<!-- ##### FUNCTION eom_uri_converter_preview ##### --> +<para> + +</para> + +@format_str: +@img: +@format: +@counter: +@n_images: +@convert_spaces: +@space_char: +@Returns: + + +<!-- ##### FUNCTION eom_uri_converter_print_list ##### --> +<para> + +</para> + +@conv: + + diff --git a/doc/reference/tmpl/eom-util.sgml b/doc/reference/tmpl/eom-util.sgml new file mode 100644 index 0000000..4907cb4 --- /dev/null +++ b/doc/reference/tmpl/eom-util.sgml @@ -0,0 +1,114 @@ +<!-- ##### SECTION Title ##### --> +eom-util + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION eom_util_show_help ##### --> +<para> + +</para> + +@section: +@parent: + + +<!-- ##### FUNCTION eom_util_make_valid_utf8 ##### --> +<para> + +</para> + +@name: +@Returns: + + +<!-- ##### FUNCTION eom_util_parse_uri_string_list_to_file_list ##### --> +<para> + +</para> + +@uri_list: +@Returns: + + +<!-- ##### FUNCTION eom_util_string_list_to_file_list ##### --> +<para> + +</para> + +@string_list: +@Returns: + + +<!-- ##### FUNCTION eom_util_strings_to_file_list ##### --> +<para> + +</para> + +@strings: +@Returns: + + +<!-- ##### FUNCTION eom_util_string_array_to_list ##### --> +<para> + +</para> + +@files: +@create_uri: +@Returns: + + +<!-- ##### FUNCTION eom_util_string_array_make_absolute ##### --> +<para> + +</para> + +@files: +@Returns: + + +<!-- ##### FUNCTION eom_util_launch_desktop_file ##### --> +<para> + +</para> + +@filename: +@user_time: +@Returns: + + +<!-- ##### FUNCTION eom_util_dot_dir ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_util_file_is_persistent ##### --> +<para> + +</para> + +@file: +@Returns: + + diff --git a/doc/reference/tmpl/eom-window.sgml b/doc/reference/tmpl/eom-window.sgml new file mode 100644 index 0000000..387c641 --- /dev/null +++ b/doc/reference/tmpl/eom-window.sgml @@ -0,0 +1,196 @@ +<!-- ##### SECTION Title ##### --> +EomWindow + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO EOM_WINDOW_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### ENUM EomWindowMode ##### --> +<para> + +</para> + +@EOM_WINDOW_MODE_UNKNOWN: +@EOM_WINDOW_MODE_NORMAL: +@EOM_WINDOW_MODE_FULLSCREEN: +@EOM_WINDOW_MODE_SLIDESHOW: + +<!-- ##### ENUM EomWindowError ##### --> +<para> + +</para> + +@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 ##### --> +<para> + +</para> + +@EOM_STARTUP_FULLSCREEN: +@EOM_STARTUP_SLIDE_SHOW: +@EOM_STARTUP_DISABLE_COLLECTION: + +<!-- ##### STRUCT EomWindow ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EomWindow::prepared ##### --> +<para> + +</para> + +@eomwindow: the object which received the signal. + +<!-- ##### ARG EomWindow:startup-flags ##### --> +<para> + +</para> + +<!-- ##### FUNCTION eom_window_new ##### --> +<para> + +</para> + +@flags: +@Returns: + + +<!-- ##### FUNCTION eom_window_get_mode ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION eom_window_set_mode ##### --> +<para> + +</para> + +@window: +@mode: + + +<!-- ##### FUNCTION eom_window_get_ui_manager ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION eom_window_get_store ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION eom_window_get_view ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION eom_window_get_sidebar ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION eom_window_get_thumb_view ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION eom_window_get_thumb_nav ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION eom_window_get_statusbar ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION eom_window_get_image ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION eom_window_open_file_list ##### --> +<para> + +</para> + +@window: +@file_list: + + +<!-- ##### FUNCTION eom_window_is_empty ##### --> +<para> + +</para> + +@window: +@Returns: + + diff --git a/doc/reference/tmpl/uta.sgml b/doc/reference/tmpl/uta.sgml new file mode 100644 index 0000000..4ae79aa --- /dev/null +++ b/doc/reference/tmpl/uta.sgml @@ -0,0 +1,85 @@ +<!-- ##### SECTION Title ##### --> +uta + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION uta_ensure_size ##### --> +<para> + +</para> + +@uta: +@x1: +@y1: +@x2: +@y2: +@Returns: + + +<!-- ##### FUNCTION uta_add_rect ##### --> +<para> + +</para> + +@uta: +@x1: +@y1: +@x2: +@y2: +@Returns: + + +<!-- ##### FUNCTION uta_remove_rect ##### --> +<para> + +</para> + +@uta: +@x1: +@y1: +@x2: +@y2: + + +<!-- ##### FUNCTION uta_find_first_glom_rect ##### --> +<para> + +</para> + +@uta: +@rect: +@max_width: +@max_height: + + +<!-- ##### FUNCTION uta_copy_area ##### --> +<para> + +</para> + +@uta: +@src_x: +@src_y: +@dest_x: +@dest_y: +@width: +@height: + + diff --git a/doc/reference/tmpl/zoom.sgml b/doc/reference/tmpl/zoom.sgml new file mode 100644 index 0000000..b26005f --- /dev/null +++ b/doc/reference/tmpl/zoom.sgml @@ -0,0 +1,49 @@ +<!-- ##### SECTION Title ##### --> +zoom + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION zoom_fit_size ##### --> +<para> + +</para> + +@dest_width: +@dest_height: +@src_width: +@src_height: +@upscale_smaller: +@width: +@height: + + +<!-- ##### FUNCTION zoom_fit_scale ##### --> +<para> + +</para> + +@dest_width: +@dest_height: +@src_width: +@src_height: +@upscale_smaller: +@Returns: + + |