Main Page
Modules
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Properties
Friends
Macros
Groups
Pages
HelpManager.cpp
Go to the documentation of this file.
1
/* Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.
2
3
This file is part of the TerraLib - a Framework for building GIS enabled applications.
4
5
TerraLib is free software: you can redistribute it and/or modify
6
it under the terms of the GNU Lesser General Public License as published by
7
the Free Software Foundation, either version 3 of the License,
8
or (at your option) any later version.
9
10
TerraLib is distributed in the hope that it will be useful,
11
but WITHOUT ANY WARRANTY; without even the implied warranty of
12
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
GNU Lesser General Public License for more details.
14
15
You should have received a copy of the GNU Lesser General Public License
16
along with TerraLib. See COPYING. If not, write to
17
TerraLib Team at <terralib-team@terralib.org>.
18
*/
19
20
/*!
21
\file terralib/qt/widgets/help/HelpManager.h
22
23
\brief A singleton that contains a pointer to a help manager implementation.
24
*/
25
26
// TerraLib
27
#include "
HelpManager.h
"
28
#include "
HelpManagerImpl.h
"
29
30
void
te::qt::widgets::HelpManager::setImpl
(
HelpManagerImpl
* impl)
31
{
32
m_impl
= impl;
33
}
34
35
te::qt::widgets::HelpManagerImpl
*
te::qt::widgets::HelpManager::getImpl
()
const
36
{
37
return
m_impl;
38
}
39
40
void
te::qt::widgets::HelpManager::showHelp
(
const
QString& htmRef,
const
QString& nSpace)
41
{
42
if
(m_impl != 0)
43
m_impl->showHelp(htmRef, nSpace);
44
}
45
46
void
te::qt::widgets::HelpManager::appendDoc
(
const
QString& docRef)
47
{
48
if
(m_impl != 0)
49
m_impl->appendDoc(docRef);
50
}
51
52
te::qt::widgets::HelpManager::HelpManager
()
53
: te::common::Singleton<
HelpManager
>(),
54
m_impl(0)
55
{
56
}
57
te::qt::widgets::HelpManager::HelpManager
HelpManager()
Protected constructor. Can not be called by clients.
Definition:
HelpManager.cpp:52
te::qt::widgets::HelpManager
Facade for a te::qt::widgets::HelpManagerImpl object.
Definition:
HelpManager.h:53
te::qt::widgets::HelpManager::setImpl
void setImpl(HelpManagerImpl *impl)
Updates the HelpManagerImpl pointer.
Definition:
HelpManager.cpp:30
HelpManager.h
A singleton that contains a pointer to a help manager implementation.
te::qt::widgets::HelpManager::getImpl
HelpManagerImpl * getImpl() const
Returns the pointer to the HelpManagerImpl object being used.
Definition:
HelpManager.cpp:35
te::qt::widgets::HelpManager::showHelp
void showHelp(const QString &htmRef, const QString &nSpace="")
Opens the help on the selected page.
Definition:
HelpManager.cpp:40
HelpManagerImpl.h
An interface for a help manager implementation.
te::qt::widgets::HelpManagerImpl
An interface for help managers implementations.
Definition:
HelpManagerImpl.h:45
te::qt::widgets::HelpManager::m_impl
HelpManagerImpl * m_impl
Pointer to HelpManagerImpl to be used.
Definition:
HelpManager.h:101
te::qt::widgets::HelpManager::appendDoc
void appendDoc(const QString &docRef)
Appends a project of help documentation to the existing collection.
Definition:
HelpManager.cpp:46
TL5_2015_release
terralib5
src
terralib
qt
widgets
help
HelpManager.cpp
Generated on Wed Jun 3 2015 10:23:27 for TerraLib by
1.8.7