pdf::PluginDocImpl Class Reference

Implement all necessary interfaces for document object. If the interface is not supported, the impl can remove them from parent class list. More...

#include <document_impl.h>

Inheritance diagram for pdf::PluginDocImpl:

[legend]

Collaboration diagram for pdf::PluginDocImpl:

[legend]

Public Member Functions
	PluginDocImpl ()
	~PluginDocImpl ()
unsigned int	get_page_count ()
unsigned int	get_page_number (const std::string &anchor)
bool	get_anchor_of_page (const unsigned int page_number, std::string &anchor)
	Retrieve the anchor for given page number.
bool	get_prev_page (std::string &anchor)
	Anchor iteraotr: retrieve the previous anchor.
bool	get_next_page (std::string &anchor)
	Anchor iteraotr: retrieve the next anchor.
bool	get_original_size (const std::string &anchor, unsigned int &width, unsigned int &height)
bool	get_content_area (const std::string &anchor, RenderArea &area)
PluginRotationDegree	get_page_original_rotation (const std::string &anchor)
PDFRenderer *	get_renderer ()
	Get the renderer.
PDFController &	get_doc_ctrl ()
	Get the document controller.
const string &	get_file_name ()
	Get the file name.
Data Fields
utils::Signal< PluginDocImpl * >	release_signal
	The release signal.
Friends
class	PluginViewImpl

---

Detailed Description

Implement all necessary interfaces for document object. If the interface is not supported, the impl can remove them from parent class list.

Definition at line 49 of file pdf/plugin_impl/document_impl.h.

---

Constructor & Destructor Documentation

pdf::PluginDocImpl::PluginDocImpl

(

)

Definition at line 37 of file pdf/plugin_impl/document_impl.cpp.

References IPluginDocSearch::abort_search, IPluginEventBroadcaster::add_event_receiver, utils::ObjectTable< T >::add_interface(), pdf::Signal< R, A1, A2, A3, A4, A5 >::add_slot(), IPluginDocument::close, IPluginDocNavigator::compare_anchor_location, IPluginDocSearch::create_search_criteria, IPluginDocument::create_view, IPluginDocAttributes::get_attribute, IPluginDocNavigator::get_file_name_from_anchor, IPluginDocNavigator::get_file_position_from_anchor, IPluginDocHyperlink::get_hyperlinks_in_range, IPluginDocNavigator::get_initial_anchor, IPluginDocNavigator::get_object_from_anchor, IPluginDocMarker::get_supported_marker_types, IPluginDocHyperlink::get_target_from_hyperlink, IPluginDocNavigator::get_text_from_range, IPluginDocNavigator::get_type_of_object, IPluginDocNavigator::get_words_from_range, IPluginDocMarker::has_toc, IPluginDocNavigator::is_anchor_in_current_document, IPluginDocDictionary::is_dictionary, IPluginDocHyperlink::is_hyperlink, IPluginDocument::is_open, IPluginDocument::open, _IPluginUnknown::query_interface, _IPluginUnknown::release, IPluginEventBroadcaster::remove_event_receiver, IPluginDocMarker::request_marker_trees, IPluginDocSearch::request_search_all, IPluginDocSearch::request_search_next, IPluginDocAttributes::set_attribute, and pdf::PDFController::sig_search_results_ready.

{
    // IPluginUnknown
    query_interface = query_interface_impl;
    release         = release_impl;

    // IPluginDocument
    open        = open_impl;
    is_open     = is_open_impl;
    close       = close_impl;
    create_view = create_view_impl;

    // IPluginDocNavigator
    get_initial_anchor      = get_initial_anchor_impl;
    get_object_from_anchor  = get_object_from_anchor_impl;
    get_type_of_object      = get_type_of_object_impl;
    get_words_from_range    = get_words_from_range_impl;
    get_text_from_range     = get_text_from_range_impl;
    is_anchor_in_current_document = is_anchor_in_current_document_impl;
    get_file_name_from_anchor = get_file_name_from_anchor_impl;
    get_file_position_from_anchor = get_file_position_from_anchor_impl;
    compare_anchor_location = compare_anchor_location_impl;

    // IPluginDocAttributes
    get_attribute = get_attribute_impl;
    set_attribute = set_attribute_impl;

    // IPluginEventBroadcaster
    add_event_receiver      = add_event_receiver_impl;
    remove_event_receiver   = remove_event_receiver_impl;

    // IPluginDocHyperlink
    is_hyperlink                = is_hyperlink_impl;
    get_target_from_hyperlink   = get_target_from_hyperlink_impl;
    get_hyperlinks_in_range     = get_hyperlinks_in_range_impl;

    // IPluginDocDictionary
    is_dictionary = is_dictionary_impl;

    // IPluginDocMarker
    get_supported_marker_types  = get_supported_marker_types_impl;
    request_marker_trees        = request_marker_trees_impl;
    has_toc                     = has_toc_impl;

    // IPluginDocSearch
    create_search_criteria  = create_search_criteria_impl;
    request_search_next     = request_search_next_impl;
    request_search_all      = request_search_all_impl;
    abort_search            = abort_search_impl;

    // Initialize interface and object table.
    g_instances_table.add_interface<IPluginUnknown>(this);
    g_instances_table.add_interface<IPluginDocument>(this);
    g_instances_table.add_interface<IPluginDocNavigator>(this);
    g_instances_table.add_interface<IPluginDocAttributes>(this);
    g_instances_table.add_interface<IPluginEventBroadcaster>(this);
    g_instances_table.add_interface<IPluginDocHyperlink>(this);
    g_instances_table.add_interface<IPluginDocDictionary>(this);
    g_instances_table.add_interface<IPluginDocMarker>(this);
    g_instances_table.add_interface<IPluginDocSearch>(this);

    // connect to the search ready signal
    doc_ctrl.sig_search_results_ready.add_slot(this
        , &PluginDocImpl::on_search_results_ready);

Here is the call graph for this function:

pdf::PluginDocImpl::~PluginDocImpl

(

)

Definition at line 111 of file pdf/plugin_impl/document_impl.cpp.

{

---

Member Function Documentation

bool pdf::PluginDocImpl::get_anchor_of_page	(	const unsigned int	page_number,
		std::string &	anchor
	)

Retrieve the anchor for given page number.

Definition at line 126 of file pdf/plugin_impl/document_impl.cpp.

{

bool pdf::PluginDocImpl::get_content_area	(	const std::string &	anchor,
		RenderArea &	area
	)

Definition at line 158 of file pdf/plugin_impl/document_impl.cpp.

{

PDFController& pdf::PluginDocImpl::get_doc_ctrl

(

)

[inline]

Get the document controller.

Definition at line 95 of file pdf/plugin_impl/document_impl.h.

{ return doc_ctrl; }

const string& pdf::PluginDocImpl::get_file_name

(

)

[inline]

Get the file name.

Definition at line 98 of file pdf/plugin_impl/document_impl.h.

References pdf::PDFController::name().

{ return doc_ctrl.name(); }

Here is the call graph for this function:

bool pdf::PluginDocImpl::get_next_page

(

std::string &

anchor

)

Anchor iteraotr: retrieve the next anchor.

Definition at line 137 of file pdf/plugin_impl/document_impl.cpp.

{

bool pdf::PluginDocImpl::get_original_size	(	const std::string &	anchor,
		unsigned int &	width,
		unsigned int &	height
	)

Definition at line 142 of file pdf/plugin_impl/document_impl.cpp.

{
    double w, h;
    if (doc_ctrl.get_page_crop_width(anchor, w) &&
        doc_ctrl.get_page_crop_height(anchor, h))
    {
        width = static_cast<unsigned int>(w);
        height = static_cast<unsigned int>(h);
        return true;
    }

unsigned int pdf::PluginDocImpl::get_page_count

(

)

Retrieve total page number. This function is used by PluginViewImpl

Definition at line 116 of file pdf/plugin_impl/document_impl.cpp.

{

unsigned int pdf::PluginDocImpl::get_page_number

(

const std::string &

anchor

)

Retrieve page number from anchor. This function is used by PluginViewImpl.

Definition at line 121 of file pdf/plugin_impl/document_impl.cpp.

{

PluginRotationDegree pdf::PluginDocImpl::get_page_original_rotation

(

const std::string &

anchor

)

Definition at line 164 of file pdf/plugin_impl/document_impl.cpp.

{

bool pdf::PluginDocImpl::get_prev_page

(

std::string &

anchor

)

Anchor iteraotr: retrieve the previous anchor.

Definition at line 132 of file pdf/plugin_impl/document_impl.cpp.

{

PDFRenderer* pdf::PluginDocImpl::get_renderer

(

)

[inline]

Get the renderer.

Definition at line 92 of file pdf/plugin_impl/document_impl.h.

References pdf::PDFController::get_renderer().

{ return doc_ctrl.get_renderer(); }

Here is the call graph for this function:

---

Friends And Related Function Documentation

friend class PluginViewImpl [friend]

Definition at line 272 of file pdf/plugin_impl/document_impl.h.

---

Field Documentation

utils::Signal<PluginDocImpl *> pdf::PluginDocImpl::release_signal

The release signal.

Definition at line 102 of file pdf/plugin_impl/document_impl.h.

---

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

• pdf/plugin_impl/document_impl.h
• pdf/plugin_impl/document_impl.cpp