.TH "KActionCollection" 3 "28 Jan 2004" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KActionCollection \- A managed set of \fBKAction\fP objects.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kaction.h>\fP
.PP
Inherits \fBQObject\fP.
.PP
.SS "Public Slots"

.in +1c
.ti -1c
.RI "void \fBclear\fP ()"
.br
.RI "\fIClears the entire actionCollection, deleting all actions. \fP"
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBinserted\fP (\fBKAction\fP *)"
.br
.ti -1c
.RI "void \fBremoved\fP (\fBKAction\fP *)"
.br
.ti -1c
.RI "void \fBactionHighlighted\fP (\fBKAction\fP *action)"
.br
.ti -1c
.RI "void \fBactionHighlighted\fP (\fBKAction\fP *action, bool highlight)"
.br
.ti -1c
.RI "void \fBactionStatusText\fP (const  \fBQString\fP &text)"
.br
.ti -1c
.RI "void \fBclearStatusText\fP ()"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKActionCollection\fP (\fBQWidget\fP *\fBparent\fP, const  char *\fBname\fP=0, \fBKInstance\fP *instance=0)"
.br
.ti -1c
.RI "\fBKActionCollection\fP (\fBQWidget\fP *watch, \fBQObject\fP *\fBparent\fP, const  char *\fBname\fP=0, \fBKInstance\fP *instance=0)"
.br
.RI "\fIUse this constructor if you want the collection's actions to restrict their accelerator keys to \fCwatch\fP rather than the \fCparent\fP. \fP"
.ti -1c
.RI "\fBKActionCollection\fP (const  \fBKActionCollection\fP &copy)"
.br
.ti -1c
.RI "virtual void \fBsetWidget\fP (\fBQWidget\fP *widget)"
.br
.RI "\fIThis sets the widget to which the keyboard shortcuts should be attached. \fP"
.ti -1c
.RI "void \fBsetAutoConnectShortcuts\fP (bool)"
.br
.RI "\fIThis indicates whether new actions which are created in this collection should have their keyboard shortcuts automatically connected on construction. \fP"
.ti -1c
.RI "bool \fBisAutoConnectShortcuts\fP ()"
.br
.ti -1c
.RI "bool \fBaddDocCollection\fP (\fBKActionCollection\fP *pDoc)"
.br
.RI "\fIDoc/View model. \fP"
.ti -1c
.RI "virtual \fBKAccel\fP * \fBaccel\fP ()"
.br
.RI "\fI\fBThis class or method is obsolete, it is provided for compatibility only.\fP Deprecated because of ambiguous name. \fP"
.ti -1c
.RI "virtual const  \fBKAccel\fP * \fBaccel\fP () const "
.br
.ti -1c
.RI "\fBKAccel\fP * \fBkaccel\fP ()"
.br
.RI "\fIReturns the \fBKAccel\fP object of the most recently set widget. \fP"
.ti -1c
.RI "const  \fBKAccel\fP * \fBkaccel\fP () const "
.br
.ti -1c
.RI "\fBKAccel\fP * \fBbuilderKAccel\fP () const "
.br
.ti -1c
.RI "virtual uint \fBcount\fP () const "
.br
.RI "\fIReturns the \fBKAccel\fP object associated with widget #. \fP"
.ti -1c
.RI "bool \fBisEmpty\fP () const "
.br
.ti -1c
.RI "virtual \fBKAction\fP * \fBaction\fP (int index) const "
.br
.ti -1c
.RI "virtual \fBKAction\fP * \fBaction\fP (const  char *\fBname\fP, const  char *classname=0) const "
.br
.ti -1c
.RI "virtual \fBQStringList\fP \fBgroups\fP () const "
.br
.ti -1c
.RI "virtual \fBKActionPtrList\fP \fBactions\fP (const  \fBQString\fP &group) const "
.br
.ti -1c
.RI "virtual \fBKActionPtrList\fP \fBactions\fP () const "
.br
.ti -1c
.RI "bool \fBreadShortcutSettings\fP (const  \fBQString\fP &sConfigGroup=QString::null, \fBKConfigBase\fP *pConfig=0)"
.br
.RI "\fIUsed for reading shortcut configuration from a non-XML rc file. \fP"
.ti -1c
.RI "bool \fBwriteShortcutSettings\fP (const  \fBQString\fP &sConfigGroup=QString::null, \fBKConfigBase\fP *pConfig=0) const "
.br
.RI "\fIUsed for writing shortcut configuration to a non-XML rc file. \fP"
.ti -1c
.RI "void \fBsetInstance\fP (\fBKInstance\fP *instance)"
.br
.ti -1c
.RI "\fBKInstance\fP * \fBinstance\fP () const "
.br
.ti -1c
.RI "void \fBsetXMLFile\fP (const  \fBQString\fP &)"
.br
.RI "\fIUse this to tell the KActionCollection what rc file its configuration is stored in. \fP"
.ti -1c
.RI "const  \fBQString\fP & \fBxmlFile\fP () const "
.br
.ti -1c
.RI "void \fBsetHighlightingEnabled\fP (bool enable)"
.br
.ti -1c
.RI "bool \fBhighlightingEnabled\fP () const "
.br
.ti -1c
.RI "void \fBconnectHighlight\fP (\fBQWidget\fP *container, \fBKAction\fP *action)"
.br
.ti -1c
.RI "void \fBdisconnectHighlight\fP (\fBQWidget\fP *container, \fBKAction\fP *action)"
.br
.ti -1c
.RI "\fBKActionCollection\fP (\fBQObject\fP *\fBparent\fP, const  char *\fBname\fP=0, \fBKInstance\fP *instance=0)"
.br
.ti -1c
.RI "void \fBinsert\fP (\fBKAction\fP *)"
.br
.ti -1c
.RI "void \fBremove\fP (\fBKAction\fP *)"
.br
.ti -1c
.RI "\fBKAction\fP * \fBtake\fP (\fBKAction\fP *)"
.br
.ti -1c
.RI "\fBKActionCollection\fP \fBoperator+\fP (const  \fBKActionCollection\fP &) const "
.br
.ti -1c
.RI "\fBKActionCollection\fP & \fBoperator=\fP (const  \fBKActionCollection\fP &)"
.br
.ti -1c
.RI "\fBKActionCollection\fP & \fBoperator+=\fP (const  \fBKActionCollection\fP &)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBKAction\fP"
.br
.ti -1c
.RI "class \fBKXMLGUIClient\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
A managed set of \fBKAction\fP objects. Definition at line 1761 of file kaction.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KActionCollection::KActionCollection (\fBQWidget\fP * watch, \fBQObject\fP * parent, const char * name = 0, \fBKInstance\fP * instance = 0)"
.PP
Use this constructor if you want the collection's actions to restrict their accelerator keys to \fCwatch\fP rather than the \fCparent\fP. If you don't require shortcuts, you can pass a null to the \fCwatch\fP parameter. Definition at line 3103 of file kaction.cpp.
.PP
References KStdAccel::name(), and setWidget().
.SH "Member Function Documentation"
.PP 
.SS "void KActionCollection::setWidget (\fBQWidget\fP * widget)\fC [virtual]\fP"
.PP
This sets the widget to which the keyboard shortcuts should be attached. You only need to call this if a null pointer was passed in the constructor. Definition at line 3153 of file kaction.cpp.
.PP
Referenced by KActionCollection(), and KEditToolbarWidget::KEditToolbarWidget().
.SS "void KActionCollection::setAutoConnectShortcuts (bool)"
.PP
This indicates whether new actions which are created in this collection should have their keyboard shortcuts automatically connected on construction. Set to 'false' if you will be loading XML-based settings. This is automatically done by KParts. The default is 'true'. Definition at line 3168 of file kaction.cpp.
.SS "bool KActionCollection::addDocCollection (\fBKActionCollection\fP * pDoc)"
.PP
Doc/View model. This lets you add the action collection of a document to a view's action collection. Definition at line 3178 of file kaction.cpp.
.SS "\fBKAccel\fP * KActionCollection::accel ()\fC [virtual]\fP"
.PP
\fBThis class or method is obsolete, it is provided for compatibility only.\fP Deprecated because of ambiguous name. Use \fBkaccel()\fP Definition at line 3367 of file kaction.cpp.
.PP
References kaccel().
.SS "\fBKAccel\fP * KActionCollection::kaccel ()"
.PP
Returns the \fBKAccel\fP object of the most recently set widget. Definition at line 3283 of file kaction.cpp.
.PP
Referenced by accel().
.SS "uint KActionCollection::count () const\fC [virtual]\fP"
.PP
Returns the \fBKAccel\fP object associated with widget #. Definition at line 3416 of file kaction.cpp.
.SS "bool KActionCollection::readShortcutSettings (const \fBQString\fP & sConfigGroup = QString::null, \fBKConfigBase\fP * pConfig = 0)"
.PP
Used for reading shortcut configuration from a non-XML rc file. Definition at line 3406 of file kaction.cpp.
.SS "bool KActionCollection::writeShortcutSettings (const \fBQString\fP & sConfigGroup = QString::null, \fBKConfigBase\fP * pConfig = 0) const"
.PP
Used for writing shortcut configuration to a non-XML rc file. Definition at line 3411 of file kaction.cpp.
.SS "void KActionCollection::setXMLFile (const \fBQString\fP &)"
.PP
Use this to tell the KActionCollection what rc file its configuration is stored in. Definition at line 3471 of file kaction.cpp.
.PP
Referenced by KXMLGUIClient::setXMLFile().
.SS "void KActionCollection::clear ()\fC [slot]\fP"
.PP
Clears the entire actionCollection, deleting all actions. \fBSee also:\fP
.RS 4
#remove 
.RE
.PP
Definition at line 3366 of file kaction.cpp.

.SH "Author"
.PP 
Generated automatically by Doxygen for kdeui Library from the source code.
