LeechCraft Monocle
0.6.70-13729-g7046a9d2a7
Modular document viewer for LeechCraft
ihavetoc.h
Go to the documentation of this file.
1
/**********************************************************************
2
* LeechCraft - modular cross-platform feature rich internet client.
3
* Copyright (C) 2006-2014 Georg Rudoy
4
*
5
* Boost Software License - Version 1.0 - August 17th, 2003
6
*
7
* Permission is hereby granted, free of charge, to any person or organization
8
* obtaining a copy of the software and accompanying documentation covered by
9
* this license (the "Software") to use, reproduce, display, distribute,
10
* execute, and transmit the Software, and to prepare derivative works of the
11
* Software, and to permit third-parties to whom the Software is furnished to
12
* do so, all subject to the following:
13
*
14
* The copyright notices in the Software and this entire statement, including
15
* the above license grant, this restriction and the following disclaimer,
16
* must be included in all copies of the Software, in whole or in part, and
17
* all derivative works of the Software, unless such copies or derivative
18
* works are solely in the form of machine-executable object code generated by
19
* a source language processor.
20
*
21
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23
* FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
24
* SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
25
* FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
26
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27
* DEALINGS IN THE SOFTWARE.
28
**********************************************************************/
29
30
#pragma once
31
32
#include <QMetaType>
33
#include "
ilink.h
"
34
35
namespace
LC
36
{
37
namespace
Monocle
38
{
39
struct
TOCEntry
;
40
43
typedef
QList<TOCEntry>
TOCEntryLevel_t
;
44
47
struct
TOCEntry
48
{
55
ILink_ptr
Link_
;
56
59
QString
Name_
;
60
63
TOCEntryLevel_t
ChildLevel_
;
64
};
65
71
class
IHaveTOC
72
{
73
public
:
76
virtual
~IHaveTOC
() {}
77
85
virtual
TOCEntryLevel_t
GetTOC
() = 0;
86
};
87
}
88
}
89
90
Q_DECLARE_INTERFACE (
LC::Monocle::IHaveTOC
,
91
"org.LeechCraft.Monocle.IHaveTOC/1.0"
)
LC::Monocle::ILink_ptr
std::shared_ptr< ILink > ILink_ptr
Definition:
ilink.h:110
LC::Monocle::TOCEntry::Name_
QString Name_
The human-readable name of the entry.
Definition:
ihavetoc.h:59
LC::Monocle::IHaveTOC
Interface for documents supporting table of contents.
Definition:
ihavetoc.h:71
LC::Monocle::TOCEntry::Link_
ILink_ptr Link_
The link action corresponding to this entry.
Definition:
ihavetoc.h:55
LC::Monocle::TOCEntry::ChildLevel_
TOCEntryLevel_t ChildLevel_
Child items of this entry.
Definition:
ihavetoc.h:63
ilink.h
LC::Monocle::IHaveTOC::~IHaveTOC
virtual ~IHaveTOC()
Virtual destructor.
Definition:
ihavetoc.h:76
LC::Monocle::IHaveTOC::GetTOC
virtual TOCEntryLevel_t GetTOC()=0
Returns the root level of the TOC.
LC
Definition:
iannotation.h:41
LC::Monocle::TOCEntryLevel_t
QList< TOCEntry > TOCEntryLevel_t
A list of table of contents entries.
Definition:
ihavetoc.h:39
LC::Monocle::TOCEntry
A single table of contents entry.
Definition:
ihavetoc.h:47
src
plugins
monocle
interfaces
monocle
ihavetoc.h
Generated by
1.8.14