Referencia de la Clase FLReportViewerInterface

Visor de informes. Más...

#include <FLObjectFactory.h>

Diagrama de herencias de FLReportViewerInterface

Lista de todos los miembros.

Tipos públicos
enum	RenderReportFlags { Append = 0x00000001, Display = 0x00000002, PageBreak = 0x00000004 }
Slots públicos
bool	renderReport (const int initRow=0, const int initCol=0, const uint flags=FLReportViewerInterface::Display)
bool	setReportData (FLSqlQueryInterface *q)
bool	setReportData (FLDomNodeInterface *xmlDoc)
bool	setReportTemplate (const QString &t, const QString &style=QString::null)
bool	setReportTemplate (FLDomNodeInterface *xmlDoc, const QString &style=QString::null)
FLDomNodeInterface *	reportData () const
FLDomNodeInterface *	reportTemplate () const
void	exec ()
void	show ()
QString	csvData ()
void	printReport ()
void	printReportToPS (const QString &outPsFile)
void	printReportToPDF (const QString &outPdfFile)
void	setNumCopies (const int numCopies)
void	setPrintToPos (bool ptp)
void	setPrinterName (const QString &pName)
bool	reportPrinted ()
void	reparent (QWidget *parentFrame)
void	slotFirstPage ()
void	slotLastPage ()
void	slotNextPage ()
void	slotPrevPage ()
void	slotZoomUp ()
void	slotZoomDown ()
void	exportFileCSVData ()
void	exportToPDF ()
void	sendEMailPDF ()
void	saveSVGStyle ()
void	saveSimpleSVGStyle ()
void	loadSVGStyle ()
void	setAutoClose (const bool b)
void	setResolution (int dpi)
void	setPixel (int relDpi)
void	setDefaults ()
void	updateReport ()
void	updateDisplay ()
void	setStyleName (const QString &style)
MReportViewer *	rptViewer ()
void	setReportEngine (FLReportEngine *r)
void	rptViewerEmbedInParent (QWidget *parentFrame)
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 ()
QObject *	child (const QString &objName)
void	disableSlotsPrintExports (bool disablePrints=true, bool disableExports=true)
void	setName (const QString &n)
FLReportViewer *	obj ()
Señales
void	requestUpdateReport ()
Métodos públicos
	FLReportViewerInterface ()
	FLReportViewerInterface (FLReportViewer *obj)
	FLReportViewerInterface (QWidget *w, bool)
	FLReportViewerInterface (FLReportEngine *r)
	~FLReportViewerInterface ()

---

Descripción detallada

Visor de informes.

Visor para previsualizar informes o colecciones de paginas

El visor tiene tiene dos modos de funcionamiento;

• Visor con capacidades de renderizado. 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 de las enumeraciones miembro de la clase

enum FLReportViewerInterface::RenderReportFlags

Valores de enumeraciones:

Append
Display
PageBreak

---

Documentación del constructor y destructor

FLReportViewerInterface::FLReportViewerInterface

(

)

[inline]

constructor

FLReportViewerInterface::FLReportViewerInterface

(

FLReportViewer *

obj

)

[inline]

constructor

FLReportViewerInterface::FLReportViewerInterface	(	QWidget *	w,
		bool
	)		[inline]

constructor

FLReportViewerInterface::FLReportViewerInterface

(

FLReportEngine *

r

)

[inline]

constructor

FLReportViewerInterface::~FLReportViewerInterface

(

)

[inline]

destructor

---

Documentación de las funciones miembro

void FLReportViewerInterface::appendPage

(

)

[inline, slot]

QObject* FLReportViewerInterface::child

(

const QString &

objName

)

[inline, slot]

Devuelve un objeto hijo del visor

Parámetros:

objName.

Nombre del objeto hijo

Devuelve:

Objeto hijo

void FLReportViewerInterface::clearPages

(

)

[inline, slot]

QString FLReportViewerInterface::csvData

(

)

[inline, slot]

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 FLReportViewerInterface::disableSlotsPrintExports	(	bool	disablePrints = true,
		bool	disableExports = true
	)		[inline, 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 FLReportViewerInterface::exec

(

)

[inline, slot]

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

void FLReportViewerInterface::exportFileCSVData

(

)

[inline, slot]

Exporta a un fichero de disco la version CSV del informe

void FLReportViewerInterface::exportToPDF

(

)

[inline, slot]

Exporta el informe a un fichero en formato PDF

int FLReportViewerInterface::getCurrentIndex

(

)

[inline, slot]

FLPicture* FLReportViewerInterface::getCurrentPage

(

)

[inline, slot]

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

FLPicture* FLReportViewerInterface::getFirstPage

(

)

[inline, slot]

FLPicture* FLReportViewerInterface::getLastPage

(

)

[inline, slot]

FLPicture* FLReportViewerInterface::getNextPage

(

)

[inline, slot]

FLPicture* FLReportViewerInterface::getPageAt

(

uint

i

)

[inline, slot]

FLPicture* FLReportViewerInterface::getPreviousPage

(

)

[inline, slot]

void FLReportViewerInterface::loadSVGStyle

(

)

[inline, slot]

Carga y aplica una plantilla de estilo SVG

FLReportViewer* FLReportViewerInterface::obj

(

)

[inline, slot]

int FLReportViewerInterface::pageCount

(

)

[inline, slot]

QSize FLReportViewerInterface::pageDimensions

(

)

[inline, slot]

int FLReportViewerInterface::pageOrientation

(

)

[inline, slot]

int FLReportViewerInterface::pageSize

(

)

[inline, slot]

void FLReportViewerInterface::printReport

(

)

[inline, slot]

Imprime directamente el informe sin mostrarlo

void FLReportViewerInterface::printReportToPDF

(

const QString &

outPdfFile

)

[inline, slot]

Imprime directamente el informe en un fichero PDF sin mostrarlo

void FLReportViewerInterface::printReportToPS

(

const QString &

outPsFile

)

[inline, slot]

Imprime directamente el informe en un fichero PS sin mostrarlo

bool FLReportViewerInterface::renderReport	(	const int	initRow = 0,
		const int	initCol = 0,
		const uint	flags = FLReportViewerInterface::Display
	)		[inline, slot]

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

void FLReportViewerInterface::reparent

(

QWidget *

parentFrame

)

[inline, slot]

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

FLDomNodeInterface* FLReportViewerInterface::reportData

(

)

const [inline, slot]

Devuelve:

Los datos de origen del informe en un documento XML con el formato usado por Kugar. Se debe llamar despues de establecer los datos para el informe con set*ReportData, de lo contrario el resultado ser� indefinido. Importante: Devuelve un nodo de referencia al arbol XML interno usado para crear el informe, si se modifica ese nodo se est� modificando el XML interno del informe. Se debe llamar a cloneNode si se desea trabajar sobre una copiar.

bool FLReportViewerInterface::reportPrinted

(

)

[inline, slot]

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

FLDomNodeInterface* FLReportViewerInterface::reportTemplate

(

)

const [inline, slot]

Devuelve:

Plantilla del informe en un documento XML con el formato usado por Kugar. Se debe llamar despues de establecer los datos para el informe con set*ReportTemplate, de lo contrario el resultado ser� indefinido. Importante: Devuelve un nodo de referencia al arbol XML interno usado para crear el informe, si se modifica ese nodo se est� modificando el XML interno del informe. Se debe llamar a cloneNode si se desea trabajar sobre una copiar.

void FLReportViewerInterface::requestUpdateReport

(

)

[signal]

Se�al emitida cuando se va a actualizar el informe

MReportViewer* FLReportViewerInterface::rptViewer

(

)

[inline, slot]

Visor b�sico de Kugar

void FLReportViewerInterface::rptViewerEmbedInParent

(

QWidget *

parentFrame

)

[inline, slot]

Incrusta el visor b�sico de Kugar en la capa principal de un objeto widget padre ( generalmente un QFrame )

void FLReportViewerInterface::saveSimpleSVGStyle

(

)

[inline, slot]

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

void FLReportViewerInterface::saveSVGStyle

(

)

[inline, slot]

Guarda como plantilla de estilo SVG

void FLReportViewerInterface::sendEMailPDF

(

)

[inline, slot]

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

void FLReportViewerInterface::setAutoClose

(

const bool

b

)

[inline, 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 FLReportViewerInterface::setCurrentPage

(

int

idx

)

[inline, slot]

void FLReportViewerInterface::setDefaults

(

)

[inline, slot]

void FLReportViewerInterface::setName

(

const QString &

n

)

[inline, slot]

void FLReportViewerInterface::setNumCopies

(

const int

numCopies

)

[inline, slot]

Establece el n�mero de copias por defecto a imprimir

void FLReportViewerInterface::setPageDimensions

(

QSize

dim

)

[inline, slot]

void FLReportViewerInterface::setPageOrientation

(

int

o

)

[inline, slot]

void FLReportViewerInterface::setPageSize

(

int

s

)

[inline, slot]

void FLReportViewerInterface::setPixel

(

int

relDpi

)

[inline, slot]

void FLReportViewerInterface::setPrinterName

(

const QString &

pName

)

[inline, slot]

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 FLReportViewerInterface::setPrintToPos

(

bool

ptp

)

[inline, slot]

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

bool FLReportViewerInterface::setReportData

(

FLSqlQueryInterface *

q

)

[inline, slot]

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 FLReportViewerInterface::setReportData

(

FLDomNodeInterface *

xmlDoc

)

[inline, slot]

Establece los datos del informe a partir de un documento XML

Parámetros:

xmlDoc

Objeto FLDomDocument con los datos

Devuelve:

TRUE si todo ha ido bien

void FLReportViewerInterface::setReportEngine

(

FLReportEngine *

r

)

[inline, slot]

Establece el motor de informes a usar por visor

void FLReportViewerInterface::setReportPages

(

FLReportPages *

pgs

)

[inline, slot]

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 FLReportViewerInterface::setReportTemplate	(	const QString &	t,
		const QString &	style = QString::null
	)		[inline, slot]

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 FLReportViewerInterface::setReportTemplate	(	FLDomNodeInterface *	xmlDoc,
		const QString &	style = QString::null
	)		[inline, slot]

Establece la plantilla para el informe.

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

Parámetros:

xmlDoc	Nombre de la plantilla en formato xml
style	Nombre de la hoja de estilo a aplicar

Devuelve:

TRUE si todo ha ido bien

void FLReportViewerInterface::setResolution

(

int

dpi

)

[inline, slot]

Establece la resolucion de la impresora

Parámetros:

dpi	Resolucion en puntos por pulgada

void FLReportViewerInterface::setStyleName

(

const QString &

style

)

[inline, slot]

Establece el nombre del estilo

void FLReportViewerInterface::show

(

)

[inline, slot]

void FLReportViewerInterface::slotFirstPage

(

)

[inline, slot]

Muestra la primera p�gina del informe

void FLReportViewerInterface::slotLastPage

(

)

[inline, slot]

Muestra la �tlima p�gina del informe

void FLReportViewerInterface::slotNextPage

(

)

[inline, slot]

Muestra la siguiente p�gina del informe

void FLReportViewerInterface::slotPrevPage

(

)

[inline, slot]

Muestra la anterior p�gina del informe

void FLReportViewerInterface::slotZoomDown

(

)

[inline, slot]

Disminuye zoom de la p�gina actual

void FLReportViewerInterface::slotZoomUp

(

)

[inline, slot]

Aumenta zoom de la p�gina actual

void FLReportViewerInterface::updateDisplay

(

)

[inline, slot]

Actualiza el visor, redibujando la coleccion de paginas en pantalla

void FLReportViewerInterface::updateReport

(

)

[inline, 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 del siguiente fichero:

• src/flbase/FLObjectFactory.h