'\" t
.\"     Title: \fBkgendesignerplugin\fR
.\"    Author: Richard Johnson <rjohnson@kde.org>
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 28/05/2014
.\"    Manual: KDE Frameworks: KDesignerPlugin
.\"    Source: KDE Frameworks Frameworks 5.0
.\"  Language: Portuguese (Brazil)
.\"
.TH "\FBKGENDESIGNERPLUGI" "1" "28/05/2014" "KDE Frameworks Frameworks 5.0" "KDE Frameworks: KDesignerPlugi"
.\" -----------------------------------------------------------------
.\" * 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 plugins de widgets para o Qt(TM) Designer\&.
.SH "SINOPSE"
.HP \w'\fBkgendesignerplugin\fR\ 'u
\fBkgendesignerplugin\fR [\fIOP\(,C\(~OES\fR...] \fIarquivo\fR
.SH "DESCRI\(,c\(~aO"
.PP
Os plugins de widgets personalizados do
Qt(TM)
Designer normalmente seguem um padr\(~ao normal, sendo que as classes oferecidas pelo plugin 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 desenvolvedores das bibliotecas que fornecem novos widgets, a cria\(,c\(~ao de um desses plugins, sem a necessidade de criar todo o c\('odigo acess\('orio associado, oferecendo um arquivo de descri\(,c\(~ao do tipo INI\&.
.PP
O
\fBkgendesignerplugin\fR
escolhe op\(,c\(~oes predefinidas para a maioria das defini\(,c\(~oes, sendo necess\('aria apenas alguma configura\(,c\(~ao m\('inima\&.
.SH "OP\(,c\(~oES"
.PP
\fB\-o \fR\fB\fIarquivo\fR\fR
.RS 4
O nome do arquivo 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 padr\(~ao da op\(,c\(~ao \*(AqPluginName\*(Aq no arquivo de entrada\&.
.RE
.PP
\fB\-g \fR\fB\fIgrupo\fR\fR
.RS 4
Fornecido para fins de compatibilidade\&. O valor padr\(~ao da op\(,c\(~ao \*(AqDefaultGroup\*(Aq no arquivo 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 sobre a 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 informa\(,c\(~oes sobre a vers\(~ao\&.
.RE
.SH "FORMATO DO ARQUIVO"
.PP
O arquivo de entrada \('e um arquivo de configura\(,c\(~ao do tipo INI (para ser mais espec\('ifico, est\('a no formato suportado pelo framework KConfig) que descreve um conjunto de widgets\&. Cont\('em uma se\(,c\(~ao
[Global], que oferece informa\(,c\(~oes gerais sobre o plugin, assim como uma se\(,c\(~ao para cada widget que dever\('a ser inclu\('ido no plugin\&.
.PP
A se\(,c\(~ao
[Global]
pode ter os seguintes itens:
.PP
\fIDefaultGroup\fR
.RS 4
O valor padr\(~ao para o item
\fIGroup\fR
nas se\(,c\(~oes das classes (padr\(~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 arquivos de inclus\(~ao necess\('arios (padr\(~ao: em branco)\&. Repare que os arquivos de cabe\(,calho dos widgets definidos posteriormente no arquivo n\(~ao devem ser indicados aqui\&. Em vez disso, este campo serve para arquivos de cabe\(,calho especiais para uso do pr\('oprio plugin, como os das classes que fornecem visualiza\(,c\(~oes\&.
.RE
.PP
\fIPluginName\fR
.RS 4
Nome da classe principal em C++ no plugin (padr\(~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 se\(,c\(~ao
[\fIClassName\fR], a qual poder\('a incluir os seguintes itens:
.PP
\fICodeTemplate\fR
.RS 4
O valor devolvido pela fun\(,c\(~ao
codeTemplate()
do plugin, o qual est\('a marcado para "uso futuro" pelo
Qt(TM)
Designer (padr\(~ao: em branco)\&.
.RE
.PP
\fIConstructorArgs\fR
.RS 4
Os argumentos para passar ao construtor da classe indicada por
ImplClass; estes devem estar entre par\(^enteses (padr\(~ao: "(parent)")\&. A \('unica vari\('avel que est\('a com certeza dispon\('ivel \('e a
\fIparent\fR, que \('e o
QWidgetpai passado pelo
Qt(TM)
Designer\&.
.sp
Este item \('e ignorado se estiver definido como
CreateWidget\&.
.RE
.PP
\fICreateWidget\fR
.RS 4
O c\('odigo necess\('ario para criar uma inst\(^ancia do widget (padr\(~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 interface gr\('afica em XML do widget (padr\(~ao: o valor fornecido pelos arquivos de cabe\(,calho do plugin do
Qt(TM)
Designer)\&.
.RE
.PP
\fIGroup\fR
.RS 4
O grupo sob o qual mostrar o widget no
Qt(TM)
Designer (padr\(~ao: o valor do item
\fIDefaultGroup\fR
na se\(,c\(~ao
[Global])\&.
.RE
.PP
\fIIconName\fR
.RS 4
Arquivo de imagem ou nome do \('icone padr\(~ao a ser usado como \('icone para este widget na lista de widgets do
Qt(TM)
Designer (padr\(~ao: um arquivo PNG com o nome da se\(,c\(~ao, sem quaisquer dois pontos duplos, na pasta "pics" de um arquivo de recursos compilado\&. Por exemplo,
:/pics/Foo\&.png
na se\(,c\(~ao
[Foo]
ou
:/pics/FooBar\&.png
na se\(,c\(~ao
[Foo::Bar])\&.
.RE
.PP
\fIImplClass\fR
.RS 4
A classe que dever\('a ser usada para criar uma inst\(^ancia do widget para ser usado no
Qt(TM)
Designer (padr\(~ao: nome da se\(,c\(~ao)\&. Lembre\-se de que esta n\(~ao precisa ser a classe que seria criada para um aplicativo final: isso \('e determinado pelo
DomXML\&.
.sp
Este item \('e ignorado se estiver definido como
CreateWidget\&.
.RE
.PP
\fIIncludeFile\fR
.RS 4
O cabe\(,calho que dever\('a ser inclu\('ido para usar este widget (padr\(~ao: a vers\(~ao em min\('usculo do nome da se\(,c\(~ao, retirando todos os dois pontos e adicionando o texto "\&.h"\&. Por exemplo,
foo\&.h
na se\(,c\(~ao
[Foo]
ou
foobar\&.h
na se\(,c\(~ao
[Foo::Bar])\&.
.RE
.PP
\fIIsContainer\fR
.RS 4
Se este widget pode conter ou n\(~ao outros widgets (padr\(~ao:
false)\&.
.RE
.PP
\fIToolTip\fR
.RS 4
A dica a ser exibida quando passar o ponteiro do mouse sobre o widget na lista de widgets do
Qt(TM)
Designer (padr\(~ao: o nome da se\(,c\(~ao, com o texto " Widget" adicionado\&. Por exemplo,
Foo Widget
na se\(,c\(~ao
[Foo])\&.
.RE
.PP
\fIWhatsThis\fR
.RS 4
O texto \*(AqO que \('e isto?\*(Aq associado com o widget no
Qt(TM)
Designer (padr\(~ao: o nome da se\(,c\(~ao, com o texto " Widget" adicionado\&. Por exemplo,
Foo Widget
na se\(,c\(~ao
[Foo])\&.
.RE
.SH "EXEMPLOS"
.PP
O arquivo de descri\(,c\(~ao mais simples poder\('a ser algo do tipo
.sp
.if n \{\
.RS 4
.\}
.nf

[Foo]
ToolTip=Displays foos
[Bar]
ToolTip=Bar editor

    
.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, voc\(^e vai querer alterar pelo menos o texto vis\('ivel ao usu\('ario, o que corresponde aos itens
ToolTip,
WhatsThis
e
Group\&. Al\('em disso, definir o nome do plugin poder\('a ser uma boa ideia para evitar poss\('iveis conflitos de s\('imbolos e para n\(~ao confundir os depuradores (tanto o aplicativo de depura\(,c\(~ao quanto a pessoa que efetua a mesma):
.sp
.if n \{\
.RS 4
.\}
.nf
[Global]
PluginName=QualquerWidget
DefaultGroup=Visualiza\(,c\(~ao

[Foo]
ToolTip=Mostra ursos
WhatsThis=Um widget de imagens que mostra ursos dan\(,cando

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

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

[Foo::Bar]
ToolTip=Mostra barras
WhatsThis=Um widget que mostra as barras de uma determinada forma
IncludeFile=foo/bar\&.h
IconName=:/previews/bar\&.png

[Foo::Baz]
IncludeFile=foo/baz\&.h
ConstructorArgs=(Foo::Baz::SomeOption, parent)
Group=Foo (Especial)
IsContainer=true
IconName=:/previews/baz\&.png

    
.fi
.if n \{\
.RE
.\}
.PP
Em alguns casos, os widgets muito complexos poder\(~ao necessitar da implementa\(,c\(~ao de uma "classe de visualiza\(,c\(~ao" para usar no
Qt(TM)
Designer; esta poder\('a ser uma subclasse do widget 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=visualizacoes\&.h

[WidgetBonito]
ImplClass=WidgetBonitoVisualiza\(,c\(~ao

    
.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 cria\(,c\(~ao de plugins para widgets personalizados\&.
.RE
.SH "PROBLEMAS"
.PP
Use por favor o
\m[blue]\fBbugs\&.kde\&.org\fR\m[]\&\s-2\u[1]\d\s+2
para reportar erros; n\(~ao os envie diretamente para os autores por e\-mail\&.
.SH "AUTORES"
.PP
\fBRichard Johnson\fR <\&rjohnson@kde\&.org\&>
.RS 4
Escreveu a documenta\(,c\(~ao original\&.
.RE
.PP
\fBAlex Merry\fR <\&alexmerry@kde\&.org\&>
.RS 4
Atualizou a documenta\(,c\(~ao para o KDE Frameworks 5\&.
.RE
.SH "NOTAS"
.IP " 1." 4
bugs.kde.org
.RS 4
\%http://bugs.kde.org
.RE