libcrn  3.9.5
A document image processing library
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Types | Public Member Functions | Friends | List of all members
Layout Class Reference

XML Alto layout element. More...

#include <CRNAltoLayout.hpp>

+ Inheritance diagram for Layout:
+ Collaboration diagram for Layout:

Classes

class  Page
 XML Alto Page element. More...
 

Public Types

typedef std::weak_ptr< PagePagePtr
 

Public Member Functions

 Layout (const Layout &)=delete
 
 Layout (Layout &&)=default
 
virtual ~Layout () override
 
Layoutoperator= (const Layout &)=delete
 
Layoutoperator= (Layout &&)=default
 
std::vector< Id > GetStyles () const
 Returns the list of style references. More...
 
void AddStyle (const Id &styleid)
 Adds a reference to a style. More...
 
void RemoveStyle (const Id &styleid)
 Removes a reference to a style. More...
 
PageGetPage (const Id &pid)
 Returns a page. More...
 
std::vector< PagePtrGetPages () const
 Returns the list of all pages. More...
 
PageAddPage (const Id &id_, int image_number, Option< int > width_=Option< int >(), Option< int > height_=Option< int >(), Option< Page::Position > pos=Option< Page::Position >())
 Adds a page. More...
 
PageAddPageAfter (const Id &pred, const Id &id_, int image_number, Option< int > width_=Option< int >(), Option< int > height_=Option< int >(), Option< Page::Position > pos=Option< Page::Position >())
 Adds a page after another. More...
 
PageAddPageBefore (const Id &next, const Id &id_, int image_number, Option< int > width_=Option< int >(), Option< int > height_=Option< int >(), Option< Page::Position > pos=Option< Page::Position >())
 Adds a page before another. More...
 
void RemovePage (const Id &pid)
 Removes a page. More...
 

Friends

class Root
 

Detailed Description

XML Alto layout element.

Author
Yann LEYDIER

Definition at line 30 of file CRNAltoLayout.hpp.

Member Typedef Documentation

typedef std::weak_ptr<Page> Layout::PagePtr

Definition at line 157 of file CRNAltoLayout.hpp.

Constructor & Destructor Documentation

Layout::Layout ( const Layout )
delete
Layout::Layout ( Layout &&  )
default
virtual Layout::~Layout ( )
inlineoverridevirtual

Definition at line 35 of file CRNAltoLayout.hpp.

Member Function Documentation

Page& Layout::AddPage ( const Id &  id_,
int  image_number,
Option< int >  width_ = Option< int >(),
Option< int >  height_ = Option< int >(),
Option< Page::Position pos = Option< Page::Position >() 
)

Adds a page.

Page& Layout::AddPageAfter ( const Id &  pred,
const Id &  id_,
int  image_number,
Option< int >  width_ = Option< int >(),
Option< int >  height_ = Option< int >(),
Option< Page::Position pos = Option< Page::Position >() 
)

Adds a page after another.

Page& Layout::AddPageBefore ( const Id &  next,
const Id &  id_,
int  image_number,
Option< int >  width_ = Option< int >(),
Option< int >  height_ = Option< int >(),
Option< Page::Position pos = Option< Page::Position >() 
)

Adds a page before another.

void Layout::AddStyle ( const Id &  styleid)

Adds a reference to a style.

Page& Layout::GetPage ( const Id &  pid)

Returns a page.

std::vector<PagePtr> Layout::GetPages ( ) const

Returns the list of all pages.

std::vector<Id> Layout::GetStyles ( ) const

Returns the list of style references.

Layout& Layout::operator= ( const Layout )
delete
Layout& Layout::operator= ( Layout &&  )
default
void Layout::RemovePage ( const Id &  pid)

Removes a page.

void Layout::RemoveStyle ( const Id &  styleid)

Removes a reference to a style.

Friends And Related Function Documentation

friend class Root
friend

Definition at line 182 of file CRNAltoLayout.hpp.


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