Development/Tutorials/Using KXmlGuiWindow/pt-br: Difference between revisions

From KDE TechBase
No edit summary
(Updating to match new version of source page)
 
(20 intermediate revisions by one other user not shown)
Line 12: Line 12:
Este tutorial incrementa o [[Development/Tutorials/First_program/KF5|First Program Tutorial]] e apresentará a classe {{class|KXmlGuiWindow}}.
Este tutorial incrementa o [[Development/Tutorials/First_program/KF5|First Program Tutorial]] e apresentará a classe {{class|KXmlGuiWindow}}.


In the previous tutorial, the program caused a dialog box to pop up but we're going to take steps towards a functioning application.
No tutorial anterior o programa fez aparecer uma caixa de diálogo, então vamos dar passos no sentido de criar um aplicativo funcional.




Line 19: Line 19:
==KXmlGuiWindow==
==KXmlGuiWindow==


{{class|KXmlGuiWindow}} provides a full main window view with menubars, toolbars, a statusbar and a main area in the centre for a large widget. For example, the help-menu is predefined. Most KDE applications will derive from this class as it provides an easy way to define menu and toolbar layouts through XML files (this technology is called XMLGUI and is part of the KF5::XmlGui framework). While we will not be using XMLGUI in ''this'' tutorial, we will use it in the next.
A {{class|KXmlGuiWindow}} fornece uma visualização completa da janela principal com menus, barras de ferramentas, uma barra de status e uma área principal no centro para um widget grande. Por exemplo, o menu de ajuda é predefinido. A maioria dos aplicativos KDE deriva dessa classe, pois fornece uma maneira fácil de definir layouts de menus e barras de ferramentas por meio de arquivos XML (essa tecnologia é chamada XMLGUI e faz parte da estrutura KF5::XmlGui). Embora não utilizemos XMLGUI ''neste'' tutorial, vamos usá-lo no próximo.


In order to have a useful KXmlGuiWindow, we must subclass it. So we create two files, a <tt>mainwindow.cpp</tt> and a <tt>mainwindow.h</tt> which will contain our code.
Para ter uma KXmlGuiWindow útil, precisamos criar uma subclasse. Então, criamos dois arquivos, um <tt>mainwindow.cpp</tt> e um <tt>mainwindow.h</tt> que conterão nosso código.


===mainwindow.h===
===mainwindow.h===
Line 45: Line 45:
</syntaxhighlight>
</syntaxhighlight>


First we subclass KXmlGuiWindow with <tt>class MainWindow : public KXmlGuiWindow</tt> then we declare the constructor with <tt>MainWindow(QWidget *parent = nullptr);</tt>.
Primeiro derivamos uma subclasse KXmlGuiWindow com <tt>class MainWindow : public KXmlGuiWindow</tt> e depois declaramos o construtor com <tt>MainWindow(QWidget * parent = nullptr); </tt>.


And finally, we declare a pointer to the object that will make up the bulk of our program. {{class|KTextEdit}} is a generic rich text editing widget with some niceties like cursor auto-hiding.
E, finalmente, declaramos um ponteiro para o objeto que vai compor a maior parte do nosso programa. O {{class|KTextEdit}} é um widget genérico de editor de texto rico com alguns detalhes, como ocultar automaticamente o cursor.


===mainwindow.cpp===
===mainwindow.cpp===
Line 63: Line 63:
</syntaxhighlight>
</syntaxhighlight>


First, of course, we have to include the header file containing the class declaration.
Primeiramente, é claro, temos que incluir o arquivo de cabeçalho que contém a declaração de classe.


We initialise our text editor with an object and use KXmlGuiWindow's built-in setCentralWidget() function on it which tells the KXmlGuiWindow what should appear in the central section of the window.
Inicializamos nosso editor de texto com um objeto e usamos a função interna do KXmlGuiWindow setCentralWidget(), que informa ao KXmlGuiWindow o que deve aparecer na seção central da janela.


Finally, KXmlGuiWindow::setupGUI() is called which does a lot of behind-the-scenes stuff and creates the default menu bars (Settings, Help).
Finalmente, o KXmlGuiWindow::setupGUI() é chamado, o que faz um monte de coisas nos bastidores e cria as barras de menu padrão(Configurações, Ajuda).


==Back to main.cpp==
==Back to main.cpp==


In order to actually run this window, we need to add a few lines in main.cpp:
Para realmente executar esta janela, precisamos adicionar algumas linhas em main.cpp:


===main.cpp===
===main.cpp===
Line 125: Line 125:
</syntaxhighlight>
</syntaxhighlight>


Again, we include our new header file in order to create our MainWindow object which we then display.
Novamente, incluímos nosso novo arquivo de cabeçalho para criar nosso objeto MainWindow, que então exibimos.


==CMake==
==CMake==


The best way to build the program is to use CMake. We add <tt>mainwindow.cpp</tt> to the sources list, include the XmlGui and TextWidgets (for KTextEdit) frameworks, and replace all <tt>tutorial1</tt> text to <tt>tutorial2</tt>.
A melhor maneira de criar o programa é usar o CMake. Nós adicionamos <tt>mainwindow.cpp</tt> à lista de fontes, incluímos as estruturas XmlGui e TextWidgets (para o KTextEdit) e substituímos todo o texto <tt>tutorial1</tt> por <tt>tutorial2</tt>.


===CMakeLists.txt===
===CMakeLists.txt===
Line 142: Line 142:


find_package(ECM 1.0.0 REQUIRED NO_MODULE)
find_package(ECM 1.0.0 REQUIRED NO_MODULE)
set(CMAKE_MODULE_PATH ${ECM_MODULE_PATH} ${ECM_KDE_MODULE_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/cmake)
set(CMAKE_MODULE_PATH ${ECM_MODULE_PATH} ${CMAKE_CURRENT_SOURCE_DIR}/cmake)


include(KDEInstallDirs)
include(KDEInstallDirs)
Line 178: Line 178:
</syntaxhighlight>
</syntaxhighlight>


=== Compile and run ===
 
The best way to compile, link and run it is to [[Getting_Started/Build|set up a correct build environment]]. But for a simple tutorial like this, it's enough to just create a build directory and build from there. This command takes cafe of all of that in one line:
=== Compilar e executar ===
A melhor maneira de compilar, linkar e executar é [[Getting_Started/Build|configurar um ambiente de compilação correto]]. Mas, para um tutorial simples como este, basta criar um diretório de compilação e compilar a partir daí. Este comando faz tudo isso em uma linha:
<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
mkdir build && cd build && cmake .. && make && ./tutorial2
mkdir build && cd build && cmake .. && make && ./tutorial2
</syntaxhighlight>
</syntaxhighlight>


==Moving On==
==Adiante==
Now you can move on to [[Development/Tutorials/Using_Actions|Using Actions]].
Agora você pode seguir para [[Development/Tutorials/Using_Actions|Usando Actions]].


[[Category:C++]]
[[Category:C++]]

Latest revision as of 16:44, 24 August 2020

Como usar a KXmlGuiWindow
Tutorial Series   Tutorial para Iniciantes
Previous   Tutorial 1 - Hello World
What's Next   Tutorial 3 - QActions and XMLGUI
Further Reading   KXmlGuiWindow

Resumo

Este tutorial incrementa o First Program Tutorial e apresentará a classe KXmlGuiWindow.

No tutorial anterior o programa fez aparecer uma caixa de diálogo, então vamos dar passos no sentido de criar um aplicativo funcional.


KXmlGuiWindow

A KXmlGuiWindow fornece uma visualização completa da janela principal com menus, barras de ferramentas, uma barra de status e uma área principal no centro para um widget grande. Por exemplo, o menu de ajuda é predefinido. A maioria dos aplicativos KDE deriva dessa classe, pois fornece uma maneira fácil de definir layouts de menus e barras de ferramentas por meio de arquivos XML (essa tecnologia é chamada XMLGUI e faz parte da estrutura KF5::XmlGui). Embora não utilizemos XMLGUI neste tutorial, vamos usá-lo no próximo.

Para ter uma KXmlGuiWindow útil, precisamos criar uma subclasse. Então, criamos dois arquivos, um mainwindow.cpp e um mainwindow.h que conterão nosso código.

mainwindow.h

#ifndef MAINWINDOW_H
#define MAINWINDOW_H
 
#include <KXmlGuiWindow>

class KTextEdit;
 
class MainWindow : public KXmlGuiWindow
{
  public:
    explicit MainWindow(QWidget *parent = nullptr);
 
  private:
    KTextEdit* textArea;
};
 
#endif

Primeiro derivamos uma subclasse KXmlGuiWindow com class MainWindow : public KXmlGuiWindow e depois declaramos o construtor com MainWindow(QWidget * parent = nullptr); .

E, finalmente, declaramos um ponteiro para o objeto que vai compor a maior parte do nosso programa. O KTextEdit é um widget genérico de editor de texto rico com alguns detalhes, como ocultar automaticamente o cursor.

mainwindow.cpp

#include "mainwindow.h"

#include <KTextEdit>

MainWindow::MainWindow(QWidget *parent) : KXmlGuiWindow(parent)
{
  textArea = new KTextEdit();
  setCentralWidget(textArea);
  setupGUI();
}

Primeiramente, é claro, temos que incluir o arquivo de cabeçalho que contém a declaração de classe.

Inicializamos nosso editor de texto com um objeto e usamos a função interna do KXmlGuiWindow setCentralWidget(), que informa ao KXmlGuiWindow o que deve aparecer na seção central da janela.

Finalmente, o KXmlGuiWindow::setupGUI() é chamado, o que faz um monte de coisas nos bastidores e cria as barras de menu padrão(Configurações, Ajuda).

Back to main.cpp

Para realmente executar esta janela, precisamos adicionar algumas linhas em main.cpp:

main.cpp

#include <cstdlib>
#include <QApplication>
#include <QCommandLineParser>
#include <KAboutData>
#include <KLocalizedString>
#include "mainwindow.h"
 
int main (int argc, char *argv[])
{
    QApplication app(argc, argv);
    KLocalizedString::setApplicationDomain("tutorial2");
    
    KAboutData aboutData(
                         // The program name used internally. (componentName)
                         QStringLiteral("tutorial2"),
                         // A displayable program name string. (displayName)
                         i18n("Tutorial 2"),
                         // The program version string. (version)
                         QStringLiteral("1.0"),
                         // Short description of what the app does. (shortDescription)
                         i18n("A simple text area"),
                         // The license this code is released under
                         KAboutLicense::GPL,
                         // Copyright Statement (copyrightStatement = QString())
                         i18n("(c) 2015"),
                         // Optional text shown in the About box.
                         // Can contain any information desired. (otherText)
                         i18n("Some text..."),
                         // The program homepage string. (homePageAddress = QString())
                         QStringLiteral("http://example.com/"),
                         // The bug report email address
                         // (bugsEmailAddress = QLatin1String("[email protected]")
                         QStringLiteral("[email protected]"));
    aboutData.addAuthor(i18n("Name"), i18n("Task"), QStringLiteral("[email protected]"),
                         QStringLiteral("http://your.website.com"), QStringLiteral("OSC Username"));
    KAboutData::setApplicationData(aboutData);
 
    QCommandLineParser parser;
    aboutData.setupCommandLine(&parser);
    parser.process(app);
    aboutData.processCommandLine(&parser);
    
    MainWindow* window = new MainWindow();
    window->show();
    
    return app.exec();
}

Novamente, incluímos nosso novo arquivo de cabeçalho para criar nosso objeto MainWindow, que então exibimos.

CMake

A melhor maneira de criar o programa é usar o CMake. Nós adicionamos mainwindow.cpp à lista de fontes, incluímos as estruturas XmlGui e TextWidgets (para o KTextEdit) e substituímos todo o texto tutorial1 por tutorial2.

CMakeLists.txt

cmake_minimum_required(VERSION 3.0)

project (tutorial2)

set(QT_MIN_VERSION "5.3.0")
set(KF5_MIN_VERSION "5.2.0")

find_package(ECM 1.0.0 REQUIRED NO_MODULE)
set(CMAKE_MODULE_PATH ${ECM_MODULE_PATH} ${CMAKE_CURRENT_SOURCE_DIR}/cmake)

include(KDEInstallDirs)
include(KDECMakeSettings)
include(KDECompilerSettings NO_POLICY_SCOPE)
include(FeatureSummary)

find_package(Qt5 ${QT_MIN_VERSION} CONFIG REQUIRED COMPONENTS 
    Core    # QCommandLineParser, QStringLiteral
    Widgets # QApplication 
)

find_package(KF5 ${KF5_MIN_VERSION} REQUIRED COMPONENTS
    CoreAddons      # KAboutData
    I18n            # KLocalizedString
    XmlGui          # KXmlGuiWindow
    TextWidgets     # KTextEdit
)

feature_summary(WHAT ALL INCLUDE_QUIET_PACKAGES FATAL_ON_MISSING_REQUIRED_PACKAGES)
    
set(tutorial2_SRCS main.cpp mainwindow.cpp)

add_executable(tutorial2 ${tutorial2_SRCS})

target_link_libraries(tutorial2
    Qt5::Widgets
    KF5::CoreAddons
    KF5::I18n
    KF5::XmlGui
    KF5::TextWidgets
)

install(TARGETS tutorial2  ${KDE_INSTALL_TARGETS_DEFAULT_ARGS})


Compilar e executar

A melhor maneira de compilar, linkar e executar é configurar um ambiente de compilação correto. Mas, para um tutorial simples como este, basta criar um diretório de compilação e compilar a partir daí. Este comando faz tudo isso em uma linha:

mkdir build && cd build && cmake .. && make && ./tutorial2

Adiante

Agora você pode seguir para Usando Actions.