Metadata Class Reference

#include <metadata.hh>

Inheritance diagram for Metadata:

Collaboration diagram for Metadata:

Public Types
using	Ptr = boost::shared_ptr< Metadata >
Public Types inherited from PluginInformationInterface
using	Ptr = boost::shared_ptr< PluginInformationInterface >
Public Types inherited from ViewObserver
using	Ptr = boost::shared_ptr< ViewObserver >

Public Member Functions
std::string	getPluginName () override
std::string	getPluginVersion () override
void	registerCapabilities (ScroomPluginInterface::Ptr host) override
Scroom::Bookkeeping::Token	viewAdded (ViewInterface::Ptr v) override
Public Member Functions inherited from PluginInformationInterface
	PluginInformationInterface ()=default
Public Member Functions inherited from Scroom::Utils::Base
	Base ()=default
	Base (const Base &)=delete
	Base (Base &&)=delete
Base &	operator= (const Base &)=delete
Base &	operator= (Base &&)=delete
virtual	~Base ()=default
template<typename R >
boost::shared_ptr< R >	shared_from_this ()
template<typename R >
boost::shared_ptr< R const >	shared_from_this () const

Static Public Member Functions
static Ptr	create ()

Private Member Functions
	Metadata ()=default

Additional Inherited Members
Public Attributes inherited from PluginInformationInterface
const int	pluginApiVersion {PLUGIN_API_VERSION}

Member Typedef Documentation

Ptr

using Metadata::Ptr = boost::shared_ptr<Metadata>

Constructor & Destructor Documentation

Metadata()

Metadata::Metadata ( )

privatedefault

Referenced by create().

Here is the caller graph for this function:

Member Function Documentation

create()

Metadata::Ptr Metadata::create ( )

static

Creates a pointer to a metadata object

Returns

Pointer to metadata object

{ return Ptr(new Metadata()); }

Referenced by getPluginInformation().

Here is the call graph for this function:

Here is the caller graph for this function:

getPluginName()

std::string Metadata::getPluginName ( )

overridevirtual

Gets the name of metadata plugin

Returns

std::string "Metadata"

Implements PluginInformationInterface.

{ return "Metadata"; }

getPluginVersion()

std::string Metadata::getPluginVersion ( )

overridevirtual

Gets the version number of metadata plugin

Returns

std::string "0.0"

Implements PluginInformationInterface.

{ return PACKAGE_VERSION; }

registerCapabilities()

void Metadata::registerCapabilities ( ScroomPluginInterface::Ptr  host )

overridevirtual

Register plugin to observers

Parameters

host	Pointer to scroom plugin interface

Returns

std::string "0.0"

Implements PluginInformationInterface.

{
  host->registerViewObserver("Metadata", shared_from_this<Metadata>());
}

viewAdded()

Scroom::Bookkeeping::Token Metadata::viewAdded ( ViewInterface::Ptr  view )

overridevirtual

Shows an image metadata button in the view that can be activated by clicking.

Parameters

view	Screen or view that is displayed

Postcondition

Metadata button is shown in toolbar

Returns

Scroom::Bookkeeping::Token token for bookkeeping of scroom

Implements ViewObserver.

{
  auto presentation          = view->getCurrentPresentation();
  auto showMetaDataInterface = boost::dynamic_pointer_cast<ShowMetadataInterface>(presentation);
  if(presentation->isPropertyDefined(METADATA_PROPERTY_NAME))
  {
    require(showMetaDataInterface);
 
    // create button for metadata and add it to the toolbar
    GtkToolItem* button         = gtk_tool_item_new();
    GtkWidget*   buttonMetadata = gtk_button_new_with_label("Metadata");
    gtk_widget_set_visible(buttonMetadata, true);
    gtk_container_add(GTK_CONTAINER(button), buttonMetadata);
    // connect signal to the button for when it is being pressed
    g_signal_connect(static_cast<gpointer>(buttonMetadata), "clicked", G_CALLBACK(on_image_properties_activate), view.get());
 
    Scroom::GtkHelpers::sync_on_ui_thread(
      [&]
      {
        view->addToToolbar(button); // adds metadata button next to other tools in toolbar
      });
  }
  return {};
}

Here is the call graph for this function:

---

The documentation for this class was generated from the following files:

• plugins/metadata/metadata.hh
• plugins/metadata/metadata.cc