Simplify util_clip_region()
[geeqie.git] / DEVELOPER-NOTES.md
index a78d324..08c72e6 100644 (file)
@@ -1,21 +1,25 @@
 # Additional Information for Developers
 
-
 ## Non-standard icons
 
-#### Collection drag-drop icon
+### Collection drag-drop icon
 
 #### ![][image_ref_gq_marker_png]
+
 Used when dropping images onto a Collection.
 Defined in `./src/icons/gq-marker.xpm`.
 
-#### Overlay Screen Display icons
+### Overlay Screen Display icons
+
+#### ![][image_ref_image_osd_color_png] IMAGE_OSD_COLOR
+
+#### ![][image_ref_image_osd_first_png] IMAGE_OSD_FIRST
+
+#### ![][image_ref_image_osd_icon_png] IMAGE_OSD_ICON
+
+#### ![][image_ref_image_osd_last_png] IMAGE_OSD_LAST
 
-##### ![][image_ref_image_osd_color_png] IMAGE_OSD_COLOR
-##### ![][image_ref_image_osd_first_png] IMAGE_OSD_FIRST
-##### ![][image_ref_image_osd_icon_png] IMAGE_OSD_ICON
-##### ![][image_ref_image_osd_last_png] IMAGE_OSD_LAST
-##### ![][image_ref_image_osd_rotate_auto_png] IMAGE_OSD_ROTATE_AUTO
+#### ![][image_ref_image_osd_rotate_auto_png] IMAGE_OSD_ROTATE_AUTO
 
 Shown in the Overlay Screen Display. Defined in `./src/image-overlay.cc image_osd_icon_pixbuf()`.
 
@@ -23,9 +27,25 @@ Shown in the Overlay Screen Display. Defined in `./src/image-overlay.cc image_os
 
 Menu processing is in `./src/layout-util.cc menu_entries[]`.
 
+## File operation overrides
+
+The standard copy, move, rename, delete and folder create functions can
+be overridden by special plugins. The following defines are in `typedefs.h`:
+
+```c
+#define CMD_COPY     "geeqie-copy-command.desktop"
+#define CMD_MOVE     "geeqie-move-command.desktop"
+#define CMD_RENAME   "geeqie-rename-command.desktop"
+#define CMD_DELETE   "geeqie-delete-command.desktop"
+#define CMD_FOLDER   "geeqie-folder-command.desktop"
+```
+
 ## Doxygen Documentation
+
 Complete code documentation in html format can be generated via the script `./scripts/doxygen.sh`.
 
+From the top level generated documentation, `Files / File List / scripts` provides a summary of files that may be useful.
+
 [image_ref_image_osd_color_png]:
 data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAC8AAAA4CAMAAABaKlG9AAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAaVBMVEUAAAAMDAwlJSUyMjJwcHCWlpbIyMjIu7vIoqLIlpbIV1fIMjLIAAC7opaiVzKWMgCiu5ZXojIylgCWyJYyyDIAyACWu6IyolcAljKWorsyV6IAMpaWlsgyMsgAAMiioshXV8i7u8j///+Wu6iCAAAAAWJLR0QiXWVcrAAAAAd0SU1FB+cMCxA4MY8D9CsAAAAQY2FOdgAAAGAAAABNAAAAEgAAAAaBW3h1AAAAiUlEQVRIx+3WwRaCIBSE4StIgqRpmqZB6Pu/ZMu7a8Ad5/Ct//0MUe4qIaOJikjUKlotiKS6RVPyWt9oA+mGe91aqNXcG3uHrCl9rn3XP6C+434Yn9A4cD/NL2ieSp9rv6xvaF243/YPtG/cO/+FvCt9rn04PHQE7s/goHBe39OUPvUPpP6N4p8ff3aBez1VWm4AAAAldEVYdGRhdGU6Y3JlYXRlADIwMjMtMTItMTFUMTY6NTY6MzcrMDA6MDAHcncUAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDIzLTEyLTExVDE2OjQ2OjEzKzAwOjAwAcszBgAAAABJRU5ErkJggg==