Referencia de la Clase FLReportViewer

#include <FLReportViewer.h>

Diagrama de herencias de FLReportViewer

Lista de todos los miembros.

Slots públicos
void	setReportEngine (FLReportEngine *r=0)
void	slotPrintReport ()
void	slotPrintReportToPS (const QString &outPsFile)
void	slotPrintReportToPDF (const QString &outPdfFile)
void	slotFirstPage ()
void	slotLastPage ()
void	slotNextPage ()
void	slotPrevPage ()
void	slotExit ()
void	slotZoomUp ()
void	slotZoomDown ()
void	exportFileCSVData ()
void	exportToPDF ()
void	sendEMailPDF ()
void	showInitCentralWidget (bool show)
void	saveSVGStyle ()
void	saveSimpleSVGStyle ()
void	loadSVGStyle ()
void	setAutoClose (bool b)
void	setResolution (int dpi)
void	setPixel (int relDpi)
void	setDefaults ()
void	updateReport ()
void	updateDisplay ()
void	disableSlotsPrintExports (bool disablePrints=true, bool disableExports=true)
Señales
void	requestUpdateReport ()
Métodos públicos
	FLReportViewer (QWidget *parent=0, const char *name=0, bool embedInParent=false, FLReportEngine *rptEngine=0)
	~FLReportViewer ()
void	exec ()
bool	renderReport (const int initRow=0, const int initCol=0, const bool append=false, const bool displayReport=false)
bool	renderReport (const int initRow=0, const int initCol=0, const uint flags=MReportViewer::Display)
bool	setReportData (FLSqlQuery *q)
bool	setReportData (FLSqlCursor *t)
bool	setReportData (QDomNode n)
bool	setReportTemplate (const QString &t, const QString &style=QString::null)
bool	setReportTemplate (QDomNode d, const QString &style=QString::null)
QSize	sizeHint () const
void	setNumCopies (const int numCopies)
void	setPrintToPos (bool ptp)
void	setPrinterName (const QString &pName)
bool	reportPrinted ()
void	setStyleName (const QString &style)
MReportViewer *	rptViewer () const
FLReportEngine *	rptEngine () const
void	rptViewerEmbedInParent (QWidget *parentFrame)
void	rptViewerReparent (QWidget *parentFrame)
QString	csvData ()
void	setReportPages (FLReportPages *pgs)
FLPicture *	getCurrentPage ()
FLPicture *	getFirstPage ()
FLPicture *	getPreviousPage ()
FLPicture *	getNextPage ()
FLPicture *	getLastPage ()
FLPicture *	getPageAt (uint i)
void	clearPages ()
void	appendPage ()
int	getCurrentIndex ()
void	setCurrentPage (int idx)
void	setPageSize (int s)
void	setPageOrientation (int o)
void	setPageDimensions (QSize dim)
int	pageSize ()
int	pageOrientation ()
QSize	pageDimensions ()
int	pageCount ()
Métodos protegidos
void	closeEvent (QCloseEvent *e)
void	showEvent (QShowEvent *e)

---

Descripción detallada

Visor para previsualizar informes o colecciones de paginas

El visor tiene tiene dos modos de funcionamiento;

• Visor con capacidades de renderizado utilizando un motor de informes Kugar. Cuando se establecen los datos y plantilla, o se le asigna un motor de renderizado. En este caso esta clase funciona como una simplificacion de alto nivel para FLReportEngine.
• S�lo visualizador de p�ginas. Cuando se le indica s�lo el conjunto de p�ginas a visualizar.

Autor:

InfoSiAL S.L.

---

Documentación del constructor y destructor

FLReportViewer::FLReportViewer	(	QWidget *	parent = 0,
		const char *	name = 0,
		bool	embedInParent = false,
		FLReportEngine *	rptEngine = 0
	)

constructor

Parámetros:

embedInParent	Si es TRUE y se ha indicado un widget padre, el visor intenta incrustarse en la capa principal del padre. Si es FALSE el visor ser� una ventana separada emergente.
rptEngine	Opcionalmente aqui se puede establecer el motor de informes a usar por el visor, de lo contrario el visor crear� su propio motor internamente.

FLReportViewer::~FLReportViewer

(

)

destructor

---

Documentación de las funciones miembro

void FLReportViewer::appendPage

(

)

void FLReportViewer::clearPages

(

)

void FLReportViewer::closeEvent

(

QCloseEvent *

e

)

[protected]

Captura evento cerrar

QString FLReportViewer::csvData

(

)

Obtiene una versi�n csv de los datos del informe (una vez ejecutado)

Solo tiene efecto si el visor tiene un motor de informes activo

void FLReportViewer::disableSlotsPrintExports	(	bool	disablePrints = true,
		bool	disableExports = true
	)		[slot]

Para desactivar las acciones por defecto para imprimir y exportar

Esto es util cuando se quieren capturar la se�ales que disparan los botones del formulario, desactivar lo que hacen por defecto, y susituirlo por funcionalidad especifica. Por ejemplo para mostrar un dialogo de impresion personalizado.

void FLReportViewer::exec

(

)

Muestra el formulario y entra en un nuevo bucle de eventos.

void FLReportViewer::exportFileCSVData

(

)

[slot]

Exporta a un fichero de disco la version CSV del informe

void FLReportViewer::exportToPDF

(

)

[slot]

Exporta el informe a un fichero en formato PDF

int FLReportViewer::getCurrentIndex

(

)

FLPicture * FLReportViewer::getCurrentPage

(

)

Metodos proporcionados por ergonomia. Son un enlace a los mismos m�todos que proporciona FLReportPages, para manejar la coleccion de paginas del visor

FLPicture * FLReportViewer::getFirstPage

(

)

FLPicture * FLReportViewer::getLastPage

(

)

FLPicture * FLReportViewer::getNextPage

(

)

FLPicture * FLReportViewer::getPageAt

(

uint

i

)

FLPicture * FLReportViewer::getPreviousPage

(

)

void FLReportViewer::loadSVGStyle

(

)

[slot]

Carga y aplica una plantilla de estilo SVG

int FLReportViewer::pageCount

(

)

QSize FLReportViewer::pageDimensions

(

)

int FLReportViewer::pageOrientation

(

)

int FLReportViewer::pageSize

(

)

bool FLReportViewer::renderReport	(	const int	initRow = 0,
		const int	initCol = 0,
		const uint	flags = MReportViewer::Display
	)

bool FLReportViewer::renderReport	(	const int	initRow = 0,
		const int	initCol = 0,
		const bool	append = false,
		const bool	displayReport = false
	)

Renderiza el informe en el visor.

S�lo tiene efecto si se han indicado datos y plantilla para el visor con setReportData y setReportTemplate, o se le ha asignado un motor de informes expl�citamente con setReportEngine o en el constructor.

Devuelve:

TRUE si todo ha ido bien

bool FLReportViewer::reportPrinted

(

)

Devuelve si el �ltimo informe ha sido imprimido en impresora o archivo.

void FLReportViewer::requestUpdateReport

(

)

[signal]

Se�al emitida cuando se va a actualizar el informe

FLReportEngine* FLReportViewer::rptEngine

(

)

const [inline]

Motor de informes de Kugar que actualmente est� usando el informe

MReportViewer* FLReportViewer::rptViewer

(

)

const [inline]

Visor b�sico de Kugar

void FLReportViewer::rptViewerEmbedInParent

(

QWidget *

parentFrame

)

Incrusta el visor b�sico de Kugar en la capa principal de un objeto widget padre.

Parámetros:

parentFrame,:

Nuevo padre. Debe ser QFrame con al menos una capa VBox

void FLReportViewer::rptViewerReparent

(

QWidget *

parentFrame

)

Cambia el widget padre del visor incrustandolo en la capa principal

Parámetros:

parentFrame,:

Nuevo padre. Debe ser QFrame con al menos una capa VBox

void FLReportViewer::saveSimpleSVGStyle

(

)

[slot]

Guarda la p�gina actual como plantilla de estilo SVG simplificada ( s�lo los campos de datos )

void FLReportViewer::saveSVGStyle

(

)

[slot]

Guarda como plantilla de estilo SVG

void FLReportViewer::sendEMailPDF

(

)

[slot]

Exporta el informe a un fichero en formato PDF y lo envia por correo el�ctronico

void FLReportViewer::setAutoClose

(

bool

b

)

[slot]

Establece si el visor debe cerrarse autom�ticamente tras imprimir el informe

Parámetros:

b	TRUE para cierre autom�tico, FALSE para desactivar cierre autom�tico

void FLReportViewer::setCurrentPage

(

int

idx

)

void FLReportViewer::setDefaults

(

)

[slot]

void FLReportViewer::setNumCopies

(

const int

numCopies

)

Establece el n�mero de copias por defecto a imprimir

void FLReportViewer::setPageDimensions

(

QSize

dim

)

void FLReportViewer::setPageOrientation

(

int

o

)

void FLReportViewer::setPageSize

(

int

s

)

void FLReportViewer::setPixel

(

int

relDpi

)

[slot]

void FLReportViewer::setPrinterName

(

const QString &

pName

)

Establece el nombre de la impresora a la que imprimir.

Si se establece el nombre de la impresora no se mostrar� el cuadro de dialogo de impresi�n, y se usar� esa impresora para imprimir directamente. Para que el cuadro de di�logo de impresi�n se muestre bastar� con establecer un nombre vac�o; setPrinterName( QString::null ).

void FLReportViewer::setPrintToPos

(

bool

ptp

)

Establece si el informe se debe imprimir en una impresora ESC/POS

bool FLReportViewer::setReportData

(

FLSqlQuery *

q

)

Establece los datos del informe a partir de una consulta

Parámetros:

q	Objeto FLSqlQuery con la consulta de la que se toman los datos

Devuelve:

TRUE si todo ha ido bien

bool FLReportViewer::setReportData

(

FLSqlCursor *

t

)

Establece los datos del informe a partir de una tabla

Parámetros:

t	Objeto FLSqlCursor con la tabla de la que se toman los datos

Devuelve:

TRUE si todo ha ido bien

bool FLReportViewer::setReportData

(

QDomNode

n

)

Establece los datos del informe a partir de un documento xml

Parámetros:

n	Objeto FLDomDocument con la tabla de la que se toman los datos

Devuelve:

TRUE si todo ha ido bien

void FLReportViewer::setReportEngine

(

FLReportEngine *

r = 0

)

[slot]

Establece el motor de informes a usar por el visor

Parámetros:

r	Motor de informes si es cero (por defecto), se quita el motor actual del visor, destruyendolo si ese motor es hijo del visor (fue construido por el)

void FLReportViewer::setReportPages

(

FLReportPages *

pgs

)

Establece directamente la coleccion de paginas a visualizar. No seran visibles hasta que no se ejecute updateDisplay.

Al estableder la colecci�n de paginas la clase pasa a ser un mero visualizador de esas p�ginas, es decir, no tiene un motor de informes asignado y los m�todos espec�ficos que llaman al motor de informes no tendran efecto (renderReport, csvData, etc..)

bool FLReportViewer::setReportTemplate	(	const QString &	t,
		const QString &	style = QString::null
	)

Establece la plantilla para el informe.

El nombre de la plantilla corresponde con el nombre del fichero con extesi�n ".kut".

Parámetros:

t	Nombre de la plantilla
style	Nombre de la hoja de estilo a aplicar

Devuelve:

TRUE si todo ha ido bien

bool FLReportViewer::setReportTemplate	(	QDomNode	d,
		const QString &	style = QString::null
	)

Establece la plantilla para el informe.

La plantilla viene dada por un nodo XML KugarTemplate

Parámetros:

d	Nodo XML que contiene la plantilla
style	Nombre de la hoja de estilo a aplicar

Devuelve:

TRUE si todo ha ido bien

void FLReportViewer::setResolution

(

int

dpi

)

[slot]

Establece la resolucion de la impresora

Parámetros:

dpi	Resolucion en puntos por pulgada

void FLReportViewer::setStyleName

(

const QString &

style

)

Establece el nombre del estilo

void FLReportViewer::showEvent

(

QShowEvent *

e

)

[protected]

Captura evento mostrar

void FLReportViewer::showInitCentralWidget

(

bool

show

)

[slot]

Muestra u oculta la ventana principal inicial

Parámetros:

show	TRUE la muestra, FALSE la oculta

QSize FLReportViewer::sizeHint

(

)

const

Reimplementaci�n de QWidget::sizeHint()

void FLReportViewer::slotExit

(

)

[slot]

Cierra el visor

void FLReportViewer::slotFirstPage

(

)

[slot]

Muestra la primera p�gina del informe

void FLReportViewer::slotLastPage

(

)

[slot]

Muestra la �tlima p�gina del informe

void FLReportViewer::slotNextPage

(

)

[slot]

Muestra la siguiente p�gina del informe

void FLReportViewer::slotPrevPage

(

)

[slot]

Muestra la anterior p�gina del informe

void FLReportViewer::slotPrintReport

(

)

[slot]

Imprime directamente el informe sin mostrarlo

void FLReportViewer::slotPrintReportToPDF

(

const QString &

outPdfFile

)

[slot]

Imprime el informe en un fichero PDF

void FLReportViewer::slotPrintReportToPS

(

const QString &

outPsFile

)

[slot]

Imprime el informe en un fichero PS

void FLReportViewer::slotZoomDown

(

)

[slot]

Disminuye zoom de la p�gina actual

void FLReportViewer::slotZoomUp

(

)

[slot]

Aumenta zoom de la p�gina actual

void FLReportViewer::updateDisplay

(

)

[slot]

Actualiza el visor, redibujando la coleccion de paginas en pantalla

void FLReportViewer::updateReport

(

)

[slot]

Actualizar el informe.

Emite la se�al requestUpdateReport y llama a updateDisplay. Si el visor tiene un motor de informes ejecuta de nuevo la consulta y el renderizado.

---

La documentación para esta clase fue generada a partir de los siguientes ficheros:

• src/flbase/FLReportViewer.h
• src/flbase/FLReportViewer.cpp