API reference ============= .. module:: tagit .. contents:: Introduction ------------ First, a few remarks to the code documentation. Classes start with an upper case letter and are written in CamelCase. Underscores show inheritance (not always, e.g. controllers). Functions are all lowercase, with underscores seperating words. Variables start with a lowercase letter (except for one-letter variables). They can contain underscores (like functions) or continie with camelCase. Controller classes start with letter 'C' View classes start with letter 'V' Core functionality ------------------ List operations ~~~~~~~~~~~~~~~ .. autofunction:: tagit.fst .. autofunction:: tagit.snd .. autofunction:: tagit.head .. autofunction:: tagit.tail .. autofunction:: tagit.unique .. autofunction:: tagit.union .. autofunction:: tagit.intersection .. autofunction:: tagit.difference .. autofunction:: tagit.split .. autofunction:: tagit.truncate_dir .. autofunction:: tagit.dict_update .. autoclass:: tagit.thread_pool.ThreadPool :members: Settings ~~~~~~~~ .. autoclass:: tagit.Settings :members: .. autofunction:: tagit.get_config .. tagit.string_types .. autoclass:: tagit.bindings.Binding :members: Console ~~~~~~~ .. autoclass:: tagit.Console :members: .. autoclass:: tagit.Colors :members: Debugging ~~~~~~~~~ .. autofunction:: tagit.debug.debug .. autofunction:: tagit.debug.doDebug Model ----- .. autoclass:: tagit.model.DataModel :members: .. autoclass:: tagit.model.db_path.DBpath :members: Tags ~~~~ .. autoclass:: tagit.model.tags.Tags :members: .. autoclass:: tagit.model.tags.Tags_SQLite :members: :show-inheritance: .. autoclass:: tagit.model.tags.Tags_Exif :members: :show-inheritance: MetaAdapter ~~~~~~~~~~~ .. autoclass:: tagit.model.meta_adapter.MetaAdapter :members: .. autoclass:: tagit.model.meta_adapter.MetaAdapter_PyExiv2 :show-inheritance: :members: Extractor ~~~~~~~~~ .. autoclass:: tagit.model.extractor.Extractor :members: .. autoclass:: tagit.model.extractor.Extractor_Constant :show-inheritance: :members: .. autoclass:: tagit.model.extractor.Extractor_Date :show-inheritance: :members: .. autoclass:: tagit.model.extractor.Extractor_Photometrics :show-inheritance: :members: .. autoclass:: tagit.model.extractor.Extractor_Path :show-inheritance: :members: .. autoclass:: tagit.model.extractor.Extractor_Aggregator :show-inheritance: :members: .. autoclass:: tagit.model.extractor.Extractor_Aggregator_all :show-inheritance: :members: Attributes ~~~~~~~~~~ .. autoclass:: tagit.model.attributes.Attributes :members: .. autoclass:: tagit.model.attributes.Attributes_SQLite :show-inheritance: :members: Thumbnailer ~~~~~~~~~~~ .. autoclass:: tagit.model.thumbnail.Thumbnailer :members: .. autoclass:: tagit.model.thumbnail.Thumbnailer_Chain :show-inheritance: :members: .. autoclass:: tagit.model.thumbnail.Thumbnailer_FS :show-inheritance: :members: .. autoclass:: tagit.model.thumbnail.Thumbnailer_FS_Flat :show-inheritance: :members: .. autoclass:: tagit.model.thumbnail.Thumbnailer_Exif :show-inheritance: :members: .. autoclass:: tagit.model.thumbnail.Thumbnailer_Database :show-inheritance: :members: .. autofunction:: tagit.model.resize.resize Token ----- .. autoclass:: tagit.token.Token :show-inheritance: :members: .. autoclass:: tagit.token.Token_Tag :show-inheritance: :members: .. autoclass:: tagit.token.Token_Image :show-inheritance: :members: .. autoclass:: tagit.token.Token_Include :show-inheritance: :members: .. autoclass:: tagit.token.Token_Exclude :show-inheritance: :members: .. autoclass:: tagit.token.Token_Attribute :show-inheritance: :members: .. autoclass:: tagit.token.Token_Height :show-inheritance: :members: .. autoclass:: tagit.token.Token_Width :show-inheritance: :members: .. autofunction:: tagit.token.token_factory Program ------- .. autoclass:: tagit.program.program.Program :members: .. autoclass:: tagit.program.bfs.Pgm_BFS :members: :show-inheritance: User interface -------------- Controller ~~~~~~~~~~ .. autoclass:: tagit.controller.controller.Controller :members: .. autoclass:: tagit.controller.controller.DataController :show-inheritance: :members: View ~~~~ .. autofunction:: tagit.view.basics.get_root .. autofunction:: tagit.view.basics.colorize .. autofunction:: tagit.view.basics.fontize *Kivy* widgets will be extended by the following three functions. They allow easy creation of the *Controller* instances. .. autofunction:: tagit.view.wx_adapter.on_parent .. autofunction:: tagit.view.wx_adapter.get_root .. autofunction:: tagit.view.wx_adapter.get_controller Main ~~~~ .. autoclass:: tagit.controller.main.CMainWindow :show-inheritance: :members: .. autoclass:: tagit.view.main.VMainWindow :show-inheritance: :members: .. autoclass:: tagit.controller.main.CMainWidget :show-inheritance: :members: .. autoclass:: tagit.view.main.VMainWidget :show-inheritance: :members: Browser ~~~~~~~ .. autoclass:: tagit.controller.browser.CBrowser :show-inheritance: :members: .. autoclass:: tagit.view.browser.VBrowser :show-inheritance: :members: Filter ~~~~~~ .. autoclass:: tagit.controller.filter.CFilter :show-inheritance: :members: .. autoclass:: tagit.view.filter.VFilter :show-inheritance: :members: Sideboxes ~~~~~~~~~ .. autoclass:: tagit.view.sidebar.VSidebar :show-inheritance: :members: .. autoclass:: tagit.controller.sidebox.db_management.CSidebox_DB_Management :show-inheritance: :members: .. autoclass:: tagit.view.sidebox.db_management.VSidebox_DB_Management :show-inheritance: :members: .. autoclass:: tagit.controller.sidebox.tags.CSidebox_Tags :show-inheritance: :members: .. autoclass:: tagit.controller.sidebox.tags_suggested.CSidebox_Tags_Suggested :show-inheritance: :members: .. autoclass:: tagit.view.sidebox.tags_suggested.VSidebox_Tags_Suggested :show-inheritance: :members: .. autoclass:: tagit.controller.sidebox.tags_browser.CSidebox_Tags_Browser :show-inheritance: :members: .. autoclass:: tagit.view.sidebox.tags_browser.VSidebox_Tags_Browser :show-inheritance: :members: .. autoclass:: tagit.controller.sidebox.tags_selection.CSidebox_Tags_Selection :show-inheritance: :members: .. autoclass:: tagit.view.sidebox.tags_selection.VSidebox_Tags_Selection :show-inheritance: :members: .. autoclass:: tagit.controller.sidebox.tags_cursor.CSidebox_Tags_Cursor :show-inheritance: :members: .. autoclass:: tagit.view.sidebox.tags_cursor.VSidebox_Tags_Cursor :show-inheritance: :members: .. autoclass:: tagit.controller.sidebox.pgm.CSidebox_Program_Control :show-inheritance: :members: .. autoclass:: tagit.view.sidebox.pgm.VSidebox_Program_Control :show-inheritance: :members: Dialogues ~~~~~~~~~ .. autoclass:: tagit.view.dialogues.dialogue.Dialogue :show-inheritance: :members: .. autoclass:: tagit.view.dialogues.TextInputDialogue :show-inheritance: :members: .. autoclass:: tagit.view.dialogues.LabelDialogue :show-inheritance: :members: .. autoclass:: tagit.view.dialogues.FilePickerDialogue :show-inheritance: :members: .. autoclass:: tagit.view.dialogues.DirPickerDialogue :show-inheritance: :members: .. autoclass:: tagit.view.dialogues.FileCreatorDialogue :show-inheritance: :members: .. autoclass:: tagit.view.dialogues.ErrorDialogue :show-inheritance: :members: .. autoclass:: tagit.view.dialogues.BindingsDialogue :show-inheritance: :members: Externals ~~~~~~~~~ .. autoclass:: tagit.external.spellcheck.Spellcheck :members: .. autoclass:: tagit.external.memoize.memoized :members: Tools ~~~~~ .. autofunction:: tagit.metrics.tags_similarity .. autofunction:: tagit.metrics.stat_per_tag .. autofunction:: tagit.metrics.stat_per_image .. autofunction:: tagit.tools.tags_histogram .. autofunction:: tagit.tools.tags_stats .. autofunction:: tagit.tools.tags_collect .. autofunction:: tagit.tools.images_export Index ----- * :ref:`genindex` * :ref:`modindex` .. EOF ..