'\" t
.\"     Title: \fBkgendesignerplugin\fR
.\"    Author: Richard Johnson <rjohnson@kde.org>
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 2014-05-28
.\"    Manual: Plataformas do KDE: KDesignerPlugin
.\"    Source: Plataformas do KDE Plataformas 5.0
.\"  Language: Portuguese
.\"
.TH "\FBKGENDESIGNERPLUGI" "1" "2014\-05\-28" "Plataformas do KDE Plataformas" "Plataformas do KDE: KDesignerP"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NOME"
kgendesignerplugin \- Gera \*(Aqplugins\*(Aq de elementos gr\('aficos para o Qt(TM) Designer\&.
.SH "SINOPSE"
.HP \w'\fBkgendesignerplugin\fR\ 'u
\fBkgendesignerplugin\fR [\fIOP\(,C\(~OES\fR...] \fIficheiro\fR
.SH "DESCRI\(,C\(~AO"
.PP
Os \*(Aqplugins\*(Aq de elementos gr\('aficos personalizados do
Qt(TM)
Designer normalmente seguem um padr\(~ao normal, sendo que as classes oferecidas pelo \*(Aqplugin\*(Aq fornecem na sua maioria alguma informa\(,c\(~ao est\('atica, em conjunto com a fun\(,c\(~ao para criar uma inst\(^ancia, a qual ser\('a normalmente uma simples chamada ao construtor\&. O
\fBkgendesignerplugin\fR
permite aos programadores das bibliotecas que fornecem elementos novos a cria\(,c\(~ao de um desses \*(Aqplugins\*(Aq, sem ter de cria todo o c\('odigo acess\('orio associado, oferecendo um ficheiro de descri\(,c\(~ao do tipo INI\&.
.PP
O
\fBkgendesignerplugin\fR
escolhe op\(,c\(~oes predefinidas para a maioria das defini\(,c\(~oes, pelo que normalmente \('e necess\('aria apenas alguma configura\(,c\(~ao m\('inima\&.
.SH "OP\(,C\(~OES"
.PP
\fB\-o \fR\fB\fIficheiro\fR\fR
.RS 4
O nome do ficheiro em C++ gerado\&. Se n\(~ao for indicado, ser\('a usado o
\fIstdout\fR\&.
.RE
.PP
\fB\-n \fR\fB\fInome\-plugin\fR\fR
.RS 4
Fornecido para fins de compatibilidade\&. O valor por omiss\(~ao da op\(,c\(~ao \*(AqPluginName\*(Aq no ficheiro de entrada\&.
.RE
.PP
\fB\-g \fR\fB\fIgrupo\fR\fR
.RS 4
Oferecido por raz\(~oes de compatibilidade\&. O valor por omiss\(~ao para a op\(,c\(~ao \*(AqDefaultGroup\*(Aq no ficheiro de entrada\&.
.RE
.PP
\fB\-\-author\fR
.RS 4
Mostra informa\(,c\(~oes sobre o autor\&.
.RE
.PP
\fB\-\-license\fR
.RS 4
Mostra informa\(,c\(~oes acerca da licen\(,ca\&.
.RE
.PP
\fB\-h, \-\-help\fR
.RS 4
Mostra um breve texto de ajuda\&.
.RE
.PP
\fB\-v , \-\-version\fR
.RS 4
Mostra a informa\(,c\(~ao da vers\(~ao\&.
.RE
.SH "FORMATO DO FICHEIRO"
.PP
O ficheiro de entrada \('e um ficheiro de configura\(,c\(~ao do tipo INI (para ser mais espec\('ifico, est\('a no formato suportado pela plataforma KConfig) que descreve um conjunto de itens gr\('aficos\&. Cont\('em uma sec\(,c\(~ao
[Global], que oferece informa\(,c\(~oes gerais acerca do \*(Aqplugin\*(Aq, assim como uma sec\(,c\(~ao para cada elemento que dever\('a ser inclu\('ido no \*(Aqplugin\*(Aq\&.
.PP
A sec\(,c\(~ao
[Global]
pode ter os seguintes elementos:
.PP
\fIDefaultGroup\fR
.RS 4
O valor por omiss\(~ao para o item
\fIGroup\fR
nas sec\(,c\(~oes das classes (por omiss\(~ao: "Custom", a menos que seja usada a op\(,c\(~ao
\fB\-g\fR)\&.
.RE
.PP
\fIIncludes\fR
.RS 4
Uma lista (separada por v\('irgulas) dos ficheiros de inclus\(~ao necess\('arios (por omiss\(~ao: vazio)\&. Repare que os ficheiros de inclus\(~ao definidos posteriormente no ficheiro n\(~ao dever\(~ao ser indicados aqui; em vez disso, este campo serve para os ficheiros de inclus\(~ao especiais para o uso pr\('oprio do \*(Aqplugin\*(Aq, como os das classes que possuem antevis\(~oes\&.
.RE
.PP
\fIPluginName\fR
.RS 4
O nome da classe principal em C++ no \*(Aqplugin\*(Aq (por omiss\(~ao: "WidgetsPlugin", a menos que seja usada a op\(,c\(~ao
\fB\-n\fR)\&.
.RE
.PP
Cada classe dever\('a ter a sua pr\('opria sec\(,c\(~ao
[\fIClassName\fR], a qual poder\('a incluir os seguintes elementos:
.PP
\fICodeTemplate\fR
.RS 4
O valor devolvido pela fun\(,c\(~ao
codeTemplate()
do \*(Aqplugin\*(Aq, o qual est\('a marcado para "uso futuro" pelo
Qt(TM)
Designer (por omiss\(~ao: vazio)\&.
.RE
.PP
\fIConstructorArgs\fR
.RS 4
Os argumentos a passar ao construtor da classe indicada por
ImplClass; estes dever\(~ao estar entre par\(^entesis (por omiss\(~ao: "(parent)")\&. A \('unica vari\('avel que \('e garantido estar dispon\('ivel \('e a
\fIparent\fR, que \('e o
QWidget\-pai passado pelo
Qt(TM)
Designer\&.
.sp
Este item \('e ignorado se estiver definido o valor de
CreateWidget\&.
.RE
.PP
\fICreateWidget\fR
.RS 4
O c\('odigo necess\('ario para criar uma inst\(^ancia do elemento gr\('afico (por omiss\(~ao: usa o
new
para criar uma inst\(^ancia da classe indicada pelo item
ImplClass, passando os argumentos definidos em
ConstructorArgs)\&. Veja as notas sobre o
ImplClass
e o
ConstructorArgs\&.
.RE
.PP
\fIDomXML\fR
.RS 4
Uma descri\(,c\(~ao da UI em XML do elemento gr\('afico (por omiss\(~ao: o valor fornecido pelos ficheiros de inclus\(~ao do \*(Aqplugin\*(Aq do
Qt(TM)
Designer)\&.
.RE
.PP
\fIGroup\fR
.RS 4
O grupo sob o qual mostrar o elemento no
Qt(TM)
Designer (por omiss\(~ao: o valor do elemento
\fIDefaultGroup\fR
na sec\(,c\(~ao
[Global])\&.
.RE
.PP
\fIIconName\fR
.RS 4
O ficheiro de imagem ou o nome do \('icone\-padr\(~ao a usar como \('icone para este elemento na lista de elementos gr\('aficos do
Qt(TM)
Designer (por omiss\(~ao: um ficheiro PNG com o nome da sec\(,c\(~ao, sem quaisquer dois\-pontos duplos, na pasta "pics" de um ficheiro de recursos compilado; por exemplo,
:/pics/Xpto\&.png
na sec\(,c\(~ao
[Xpto], ou
:/pics/XptoOla\&.png
na sec\(,c\(~ao
[Xpto::Ola])\&.
.RE
.PP
\fIImplClass\fR
.RS 4
A classe que dever\('a ser usada para criar uma inst\(^ancia do elemento para o usar no
Qt(TM)
Designer (por omiss\(~ao: o nome da sec\(,c\(~ao)\&. Lembre\-se que esta n\(~ao tem de ser a classe que seria criada para uma aplica\(,c\(~ao final: isso \('e determinado pelo
DomXML\&.
.sp
Este item \('e ignorado se estiver definido o valor de
CreateWidget\&.
.RE
.PP
\fIIncludeFile\fR
.RS 4
O ficheiro que dever\('a ser inclu\('ido para usar este item gr\('afico (por omiss\(~ao: a vers\(~ao em min\('usculas do nome da sec\(,c\(~ao, retirando todos os dois\-pontos e adicionando o texto "\&.h"; por exemplo,
xpto\&.h
na sec\(,c\(~ao
[Xpto], ou
xptoola\&.h
na sec\(,c\(~ao
[Xpto::Ola])\&.
.RE
.PP
\fIIsContainer\fR
.RS 4
Se este elemento poder\('a conter ou n\(~ao outros elementos (por omiss\(~ao:
false)\&.
.RE
.PP
\fIToolTip\fR
.RS 4
A dica a mostrar quando passar o cursor do rato sobre o elemento na lista de elementos gr\('aficos no
Qt(TM)
Designer (por omiss\(~ao: o nome da sec\(,c\(~ao, com o texto " Widget" adicionado; por exemplo,
XPTO Widget
na sec\(,c\(~ao
[XPTO])\&.
.RE
.PP
\fIWhatsThis\fR
.RS 4
O texto \*(AqO que \('e Isto?\*(Aq associado com o elemento no
Qt(TM)
Designer (por omiss\(~ao: o nome da sec\(,c\(~ao, com o texto " Widget" adicionado; por exemplo,
XPTO Widget
na sec\(,c\(~ao
[XPTO])\&.
.RE
.SH "EXEMPLOS"
.PP
O ficheiro de descri\(,c\(~ao mais simples poder\('a ser algo do tipo
.sp
.if n \{\
.RS 4
.\}
.nf

[XPTO]
ToolTip=Mostra elementos XPTO
[Bar]
ToolTip=Editor de barras

    
.fi
.if n \{\
.RE
.\}
.sp
Repare que cada classe dever\('a ter pelo menos uma chave definida (ToolTip
foi usado neste exemplo), caso contr\('ario ser\('a ignorada\&.
.PP
Normalmente, ir\('a querer alterar pelo menos o texto vis\('ivel para o utilizador, o que corresponde aos itens
ToolTip,
WhatsThis
e
Group\&. Para al\('em disso, definir o nome do \*(Aqplugin\*(Aq poder\('a ser uma boa ideia para evitar poss\('iveis conflitos de s\('imbolos e para n\(~ao confundir os depuradores (tanto a aplica\(,c\(~ao de depura\(,c\(~ao como a pessoa que efectua a mesma):
.sp
.if n \{\
.RS 4
.\}
.nf
[Global]
PluginName=ElementosXPTO
DefaultGroup=Visualiza\(,c\(~ao

[XPTO]
ToolTip=Mostra ursos
WhatsThis=Um item de imagens que mostra ursos a dan\(,car

[Ola]
ToolTip=Editor de barras
WhatsThis=Uma interface de edi\(,c\(~ao para barras para ursos
Group=Edi\(,c\(~ao

    
.fi
.if n \{\
.RE
.\}
.PP
Poder\(~ao ser necess\('arios ficheiros mais complexos, caso tenha classes com espa\(,cos de nomes ou op\(,c\(~oes extra que seja necess\('ario passar aos construtores, como por exemplo:
.sp
.if n \{\
.RS 4
.\}
.nf
[Global]
PluginName=ElementosXpto
DefaultGroup=XPTO

[XPTO::Ola]
ToolTip=Mostra barras
WhatsThis=Um elemento que mostra elementos de uma determinada forma
IncludeFile=xpto/ola\&.h
IconName=:/antevisoes/ola\&.png

[XPTO::Ola2]
IncludeFile=xpto/ola2\&.h
ConstructorArgs=(XPTO::Ola2::UmaOpcao, parent)
Group=XPTO (Especial)
IsContainer=true
IconName=:/antevisoes/ola2\&.png

    
.fi
.if n \{\
.RE
.\}
.PP
Em alguns casos, os itens gr\('aficos especialmente complexos poder\(~ao necessitar de uma implementa\(,c\(~ao de uma "classe de antevis\(~ao" para usar no
Qt(TM)
Designer; esta poder\('a ser uma sub\-classe do elemento real que simplesmente faz mais algumas configura\(,c\(~oes adicionais, ou poder\('a ent\(~ao ser uma implementa\(,c\(~ao completamente diferente\&.
.sp
.if n \{\
.RS 4
.\}
.nf
[Global]
Includes=xpto\-antevisoes\&.h

[ElementoBonito]
ImplClass=ElementoBonitoAntevisao

    
.fi
.if n \{\
.RE
.\}
.sp
.SH "VEJA TAMB\('EM"
.PP
http://qt\-project\&.org/doc/qt\-5/designer\-creating\-custom\-widgets\&.html
.RS 4
A documenta\(,c\(~ao do
Qt(TM)
Designer para criar \*(Aqplugins\*(Aq de itens gr\('aficos personalizados\&.
.RE
.SH "PROBLEMAS"
.PP
Use por favor o
\m[blue]\fBbugs\&.kde\&.org\fR\m[]\&\s-2\u[1]\d\s+2
para comunicar os erros; n\(~ao os envie directamente para os autores por e\-mail\&.
.SH "AUTORES"
.PP
\fBRichard Johnson\fR <\&rjohnson@kde\&.org\&>
.RS 4
Criador da documenta\(,c\(~ao original\&.
.RE
.PP
\fBAlex Merry\fR <\&alexmerry@kde\&.org\&>
.RS 4
Actualizou a documenta\(,c\(~ao para as Plataformas 5 do KDE\&.
.RE
.SH "NOTAS"
.IP " 1." 4
bugs.kde.org
.RS 4
\%http://bugs.kde.org
.RE