Difference between revisions of "Archive:Development/Tutorials/Using KActions (zh CN)"

Jump to: navigation, search
Line 9: Line 9:
 
pre=[[Development/Tutorials/Using_KXmlGuiWindow (zh_CN)|教程2 - 创建主窗口]], XML基础知识|
 
pre=[[Development/Tutorials/Using_KXmlGuiWindow (zh_CN)|教程2 - 创建主窗口]], XML基础知识|
  
next=TODO (milliams)|  
+
next=[[Development/Tutorials/Saving_and_loading (zh_CN)|教程4 - 保存与载入]]|  
  
 
reading=None
 
reading=None
Line 109: Line 109:
  
 
== 解释 ==
 
== 解释 ==
本教程的代码基于[[Development/Tutorials/Using_KXmlGuiWindow (zh_CN)|教程2 - 创建主窗口]]中的KXmlGuiWindow代码。大部分改动都发生在<tt>mainwindow.cpp</tt>里,其中一个重要的结构变化是,MainWindow的构造函数现在调用<tt>setupActions()</tt>而不再调用<tt>setupGUI()</tt>。在<tt>setupActions()</tt>函数中包含了新的KAction相关代码,并最终自行调用了<tt>setupGUI()</tt>函数。
+
本教程的代码基于 [[Development/Tutorials/Using_KXmlGuiWindow (zh_CN)|教程2 - 创建主窗口]] 中的KXmlGuiWindow代码。大部分改动都发生在<tt>mainwindow.cpp</tt>里,其中一个重要的结构变化是,MainWindow的构造函数现在调用<tt>setupActions()</tt>而不再调用<tt>setupGUI()</tt>。在<tt>setupActions()</tt>函数中包含了新的KAction相关代码,并最终自行调用了<tt>setupGUI()</tt>函数。
  
 
===创建KAction对象===
 
===创建KAction对象===
Line 157: Line 157:
 
将会自动创建一个带有正确的图标、文本和快捷键的KAction对象,并自动加入文档菜单。  
 
将会自动创建一个带有正确的图标、文本和快捷键的KAction对象,并自动加入文档菜单。  
  
==Adding the action to menus and toolbars==
+
==将动作添加到菜单和工具栏==
At the moment, the new "Clear" action has been created but it hasn't been associated with any menus or toolbars. This is done with a KDE technology called XMLGUI, which does nice things like movable toolbars for you.
+
现在,新的“Clear”动作已经创建,但还没有与任何菜单或工具栏相关联。这需要通过一项叫做XMLGUI的KDE技术来实现,它会自动为你实现诸如可移动的工具栏之类的功能。
  
{{note|In a later version of KDE4, XMLGUI, may be replaced with a new framework called liveui. For now, XMLGUI, is the only and correct way to set up the UI.}}
+
{{note|在以后的KDE4版本中, XMLGUI, 可能会被叫做liveui的新架构所替代。不过,目前XMLGUI还仍是唯一正确的设置用户界面的方法。}}
  
 
==XMLGUI==
 
==XMLGUI==
  
The <tt>setupGUI()</tt> function in {{class|KXmlGuiWindow}} depends on the XMLGUI system to construct the GUI, which XMLGUI does by parsing an XML file description of the interface.
+
{{class|KXmlGuiWindow}}中的<tt>setupGUI()</tt>函数依赖XMLGUI系统来创建图形用户界面。XMLGUI通过解析XML格式的界面描述文件来实现这一功能。
  
The rule for naming this XML file is <tt>appnameui.rc</tt>, where <tt>appname</tt> is the name you set in {{class|KAboutData}} (in this case, ''tutorial3''). So in our example, the file is called <tt>tutorial3ui.rc</tt>, and is located in the build directory. Where the file will ultimately be placed is handled by CMake.
+
该XML文件的命名规范是<tt>appnameui.rc</tt>, 其中<tt>appname</tt>是你在{{class|KAboutData}}中设置的程序名 (在本例中是“tutorial3”)。因此在我们的例子里,该文件被命名为<tt>tutorial3ui.rc</tt>, 位于build目录。这个文件具体放在何处,是由CMake来处理的。
  
==''appname''ui.rc File==
+
==''appname''ui.rc 文件==
  
Since the description of the UI is defined with XML, the layout must follow strict rules. This tutorial will not go into great depth on this topic, but for more information, see the [[Development/Architecture/KDE4/XMLGUI_Technology|detailed XMLGUI page]] (here is an older tutorial: [http://developer.kde.org/documentation/tutorials/xmlui/preface.html]).
+
因为用户界面的描述是用XML来定义的,因此其布局必须严格遵守规范。在本教程中将不会深入讨论这一主题,不过可以访问 [[Development/Architecture/KDE4/XMLGUI_Technology|detailed XMLGUI page]] 以获取更多信息。(这里还有一个旧的教程: [http://developer.kde.org/documentation/tutorials/xmlui/preface.html])
  
 
===tutorial3ui.rc===
 
===tutorial3ui.rc===
Line 189: Line 189:
 
</code>
 
</code>
  
The <tt><Toolbar></tt> tag allows you to describe the toolbar, which is the bar across the top of the window normally with icons. Here it is given the unique name ''mainToolBar'' and its user visible name set to ''Main Toolbar'' using the <tt><text></tt> tag. The clear action is added to the toolbar using the <tt><Action></tt> tag, the name parameter in this tag being the string that was passed to the KActionCollection with <tt>addAction()</tt> in <tt>mainwindow.cpp</tt>.
+
<tt><Toolbar></tt>标签允许你定义工具栏,即窗口上部包含图标的长条。这里,它被赋予了一个唯一的名字“mainToolBar”,并用<tt><text></tt>将它的用户可见名称设成了“Main Toolbar”。通过<tt><Action></tt>标签,“clear”动作被添加到了工具栏中。注意,该标签的“name”参数应该是在<tt>mainwindow.cpp</tt>中用<tt>addAction()</tt>传递给KActionCollection的那个名字。
  
Besides having the action in the toolbar, it can also be added to the menubar. Here the action is being added to the ''File'' menu of the <tt>MenuBar</tt> the same way it was added to the toolbar.
+
除了在工具栏中添加该工作外,它也可以被添加到菜单栏中。这里,用与工具栏添加同样的方法,将该工作添加到了<tt>工具栏(MenuBar)</tt>里的“File”菜单中。
  
Change the 'version' attribute of the <tt><nowiki><gui></nowiki></tt> tag if you changed .rc file since the last install to force a system cache update.
+
如果你在上次安装后又对.rc文件作了更新,那么需要修改<tt><nowiki><gui></nowiki></tt>标签中的“version”属性,以强制更新系统缓存。
  
 
==CMake==
 
==CMake==
Finally, the <tt>tutorial3ui.rc</tt> needs to go somewhere where KDE can find it (can't just leave it in the source directory!). '''This means the project needs to be installed somewhere.'''
+
最后, 需要将<tt>tutorial3ui.rc</tt>文件放到KDE系统可以找到的地方(不可以仅将它放到源目录中!). '''这意味着需要将项目安装到某个地方。'''
 
===CMakeLists.txt===
 
===CMakeLists.txt===
 
<code ini n>
 
<code ini n>
Line 218: Line 218:
 
</code>
 
</code>
  
This file is almost identical to the one for tutorial2, but with two extra lines at the end that describe where the files are to be installed. Firstly, the <tt>tutorial3</tt> target is installed to the <tt>BIN_INSTALL_DIR</tt> then the <tt>tutorial3ui.rc</tt> file that describes the layout of the user interface is installed to the application's data directory.
+
这个文件几乎与教程二里的相同,除了最后多出两行来描述文件将被安装到何处。首先, <tt>tutorial3</tt>目标被安装到<tt>BIN_INSTALL_DIR</tt>;然后描述用户界面布局的<tt>tutorial3ui.rc</tt>文件被安装到了应用程序数据目录。
  
===Make, Install And Run===
+
===编译, 安装与运行===
If you don't have write access to where your KDE4 installation directory, you can install it to a folder in your home directory.
+
如果你没有KDE4安装目录的写权限,可以将它安装到你的主目录下的某个文件夹里。
  
To tell CMake where to install the program, set the <tt>DCMAKE_INSTALL_PREFIX</tt> switch. You probably just want to install it somewhere local for testing (it's probably a bit silly to go to the effort of installing these tutorials to your KDE directory), so the following might be appropriate:
+
通过<tt>DCMAKE_INSTALL_PREFIX</tt>开关项,可以告诉CMake将程序安装到何处。也许你正希望将它安装到本地的某处进行测试(直接将这些教程安装到你的KDE目录里可能有点傻),因此下面的做法可能比较合适:
 
  mkdir build && cd build
 
  mkdir build && cd build
 
  cmake .. -DCMAKE_INSTALL_PREFIX=$HOME
 
  cmake .. -DCMAKE_INSTALL_PREFIX=$HOME
 
  make install
 
  make install
 
  $HOME/bin/tutorial3
 
  $HOME/bin/tutorial3
which will create a KDE-like directory structure in your user's home directory directory and will install the executable to {{path|$HOME/bin/tutorial3}}.
+
这将会在你的用户主目录下创建一个结构类似于KDE目录的目录,并将可执行文件安装到 {{path|$HOME/bin/tutorial3}}
  
==Moving On==
+
==继续进行==
Now you can move on to [[Development/Tutorials/Saving_and_loading|saving and loading]].
+
现在,你可以继续学习下一教程:[[Development/Tutorials/Saving_and_loading (zh_CN)|保存与载入]].
  
 
[[Category:C++]]
 
[[Category:C++]]

Revision as of 16:54, 30 May 2008

Template:I18n/Language Navigation Bar (zh CN)

使用KActions
Tutorial Series   初学者教程
Previous   教程2 - 创建主窗口, XML基础知识
What's Next   教程4 - 保存与载入
Further Reading   None

Contents

摘要

在本讲中我们将介绍动作(action)的概念。动作是一种为用户提供程序交互接口的统一方法。 例如,假设我们要为教程2 - 创建主窗口的用户提供通过点击工具栏中的按钮,通过菜单中的一个菜单项,再或者是通过一个组合快捷键,来清除文本区内容的功能。通过一个KAction对象,就可以实现上述的全部功能。

Introtokdetutorial3.png

KAction

{{class|KAction}是一个包含着与某个动作有关的所有信息(如图标、快捷方式等)的对象。你可以将动作连接到实际执行工作的slot上。

代码

main.cpp

  1. include <KApplication>
  2. include <KAboutData>
  3. include <KCmdLineArgs>
  1. include "mainwindow.h"

int main (int argc, char *argv[]) {

 KAboutData aboutData( "tutorial3", "tutorial3",
     ki18n("Tutorial 3"), "1.0",
     ki18n("A simple text area using KAction etc."),
     KAboutData::License_GPL,
     ki18n("Copyright (c) 2007 Developer") );
 KCmdLineArgs::init( argc, argv, &aboutData );
 KApplication app;

 MainWindow* window = new MainWindow();
 window->show();
 return app.exec();

} 这次,main.cpp中的代码几乎没有什么改动, 只是KAboutData构造器里的说明性参数改成了教程3。

mainwindow.h

  1. ifndef MAINWINDOW_H
  2. define MAINWINDOW_H
  1. include <KXmlGuiWindow>
  2. include <KTextEdit>

class MainWindow : public KXmlGuiWindow {

 public:
   MainWindow(QWidget *parent=0);
 private:
   KTextEdit* textArea;
   void setupActions();

};

  1. endif

只增加了函数void setupActions(),它负责执行设置KActions的全部工作。

mainwindow.cpp

  1. include "mainwindow.h"
  1. include <KApplication>
  2. include <KAction>
  3. include <KLocale>
  4. include <KActionCollection>
  5. include <KStandardAction>

MainWindow::MainWindow(QWidget *parent)

   : KXmlGuiWindow(parent)

{

 textArea = new KTextEdit;
 setCentralWidget(textArea);
 setupActions();

}

void MainWindow::setupActions() {

 KAction* clearAction = new KAction(this);
 clearAction->setText(i18n("Clear"));
 clearAction->setIcon(KIcon("document-new"));
 clearAction->setShortcut(Qt::CTRL + Qt::Key_W);
 actionCollection()->addAction("clear", clearAction);
 connect(clearAction, SIGNAL(triggered(bool)),
         textArea, SLOT(clear()));
 KStandardAction::quit(kapp, SLOT(quit()),
                       actionCollection());
 setupGUI();

}

解释

本教程的代码基于 教程2 - 创建主窗口 中的KXmlGuiWindow代码。大部分改动都发生在mainwindow.cpp里,其中一个重要的结构变化是,MainWindow的构造函数现在调用setupActions()而不再调用setupGUI()。在setupActions()函数中包含了新的KAction相关代码,并最终自行调用了setupGUI()函数。

创建KAction对象

我们将通过一系列的步骤来创建KAction对象。首先,在代码中包含对KAction 库的声明名并创建KAction对象:

  1. include <KAction>

... KAction* clearAction = new KAction(this); 上面这行代码创建了一个叫做clearAction的对象。

设置KAction对象属性

文字

有了KAction对象之后,我们就可以来设置它的属性。下面这段代码设置了显示在菜单中和工具栏图标下的文字。 clearAction->setText(i18n("Clear")); 注意,文字首先被i18n()函数所处理。这是翻译用户界面所必须的(更多信息,可参考i18n教程)。

图标

如果你希望动作能显示在工具栏中,那么就需要给它指定一个图标。下面的代码使用setIcon()函数,将标准KDE的document-new图标设置为动作的图标: clearAction->setIcon(KIcon("document-new"));

快捷键

设定我们的动作所对象的快捷键很简单: clearAction->setShortcut(Qt::CTRL + Qt::Key_W); 这将Ctrl+W关联到我们的KAction对象。

添加到动作集

为了让我们的动作能够被XmlGui架构访问(会在后面解释) ,必须将它添加到程序的“动作集”中。可以像下面这样,使用actionCollection()函数来访问动作集: actionCollection()->addAction("clear", clearAction); 这里我们将KAction对象clearAction加入了动作集,并将其命名为“clear”。 XmlGui架构会使用这个名字来引用该动作。

连接到动作

完成对动作的设置之后,接下来我们需要将它连接到实际进行处理的部分。在这里(因为我们希望清除文件区中的内容),我们将动作连接到KTextEdit对象的clear()方法。 connect( clearAction, SIGNAL( triggered(bool) ),

        textArea, SLOT( clear() ) );

这与Qt里的QAction的用法是相同的。

KStandardAction

对于那些几乎在所有KDE程序中出现的动作,如“退出”,“保存”及“载入”等,KDE提供了一些预定义的KAction对象。可以通过KStandardAction来访问它们。

使用它们很简单。只要在代码中包含了有关的库(#include <KStandardAction>), 你只需要简单的将你希望执行的方法和要加入的KActionCollection动作集提供给它即可。例如, KStandardAction::quit(kapp, SLOT(quit()), actionCollection()); 将会自动创建一个带有正确的图标、文本和快捷键的KAction对象,并自动加入文档菜单。

将动作添加到菜单和工具栏

现在,新的“Clear”动作已经创建,但还没有与任何菜单或工具栏相关联。这需要通过一项叫做XMLGUI的KDE技术来实现,它会自动为你实现诸如可移动的工具栏之类的功能。

noframe
 
Note
在以后的KDE4版本中, XMLGUI, 可能会被叫做liveui的新架构所替代。不过,目前XMLGUI还仍是唯一正确的设置用户界面的方法。

XMLGUI

KXmlGuiWindow中的setupGUI()函数依赖XMLGUI系统来创建图形用户界面。XMLGUI通过解析XML格式的界面描述文件来实现这一功能。

该XML文件的命名规范是appnameui.rc, 其中appname是你在KAboutData中设置的程序名 (在本例中是“tutorial3”)。因此在我们的例子里,该文件被命名为tutorial3ui.rc, 位于build目录。这个文件具体放在何处,是由CMake来处理的。

appnameui.rc 文件

因为用户界面的描述是用XML来定义的,因此其布局必须严格遵守规范。在本教程中将不会深入讨论这一主题,不过可以访问 detailed XMLGUI page 以获取更多信息。(这里还有一个旧的教程: [1])。

tutorial3ui.rc

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE kpartgui SYSTEM "kpartgui.dtd"> <gui name="tutorial3" version="1">

 <ToolBar name="mainToolBar" >
   <text>Main Toolbar</text>
   <Action name="clear" />
 </ToolBar>
 <MenuBar>
   <Menu name="file" >
     <Action name="clear" />
   </Menu>
 </MenuBar>

</gui>

<Toolbar>标签允许你定义工具栏,即窗口上部包含图标的长条。这里,它被赋予了一个唯一的名字“mainToolBar”,并用<text>将它的用户可见名称设成了“Main Toolbar”。通过<Action>标签,“clear”动作被添加到了工具栏中。注意,该标签的“name”参数应该是在mainwindow.cpp中用addAction()传递给KActionCollection的那个名字。

除了在工具栏中添加该工作外,它也可以被添加到菜单栏中。这里,用与工具栏添加同样的方法,将该工作添加到了工具栏(MenuBar)里的“File”菜单中。

如果你在上次安装后又对.rc文件作了更新,那么需要修改<gui>标签中的“version”属性,以强制更新系统缓存。

CMake

最后, 需要将tutorial3ui.rc文件放到KDE系统可以找到的地方(不可以仅将它放到源目录中!). 这意味着需要将项目安装到某个地方。

CMakeLists.txt

project(tutorial3)

find_package(KDE4 REQUIRED) include_directories(${KDE4_INCLUDES})

set(tutorial3_SRCS

 main.cpp
 mainwindow.cpp

)

kde4_add_executable(tutorial3 ${tutorial3_SRCS})

target_link_libraries(tutorial3 ${KDE4_KDEUI_LIBS})

install(TARGETS tutorial3 DESTINATION ${BIN_INSTALL_DIR}) install(FILES tutorial3ui.rc

       DESTINATION  ${DATA_INSTALL_DIR}/tutorial3)

这个文件几乎与教程二里的相同,除了最后多出两行来描述文件将被安装到何处。首先, tutorial3目标被安装到BIN_INSTALL_DIR;然后描述用户界面布局的tutorial3ui.rc文件被安装到了应用程序数据目录。

编译, 安装与运行

如果你没有KDE4安装目录的写权限,可以将它安装到你的主目录下的某个文件夹里。

通过DCMAKE_INSTALL_PREFIX开关项,可以告诉CMake将程序安装到何处。也许你正希望将它安装到本地的某处进行测试(直接将这些教程安装到你的KDE目录里可能有点傻),因此下面的做法可能比较合适:

mkdir build && cd build
cmake .. -DCMAKE_INSTALL_PREFIX=$HOME
make install
$HOME/bin/tutorial3

这将会在你的用户主目录下创建一个结构类似于KDE目录的目录,并将可执行文件安装到 $HOME/bin/tutorial3

继续进行

现在,你可以继续学习下一教程:保存与载入.


KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal