|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.kde.qt.Qt
org.kde.qt.QObject
org.kde.koala.KXMLGUIFactory
public class KXMLGUIFactory
KXMLGUIFactory, together with KXMLGUIClient objects, can be used to create
a GUI of container widgets (like menus, toolbars, etc.) and container items
(menu items, toolbar buttons, etc.) from an XML document and action objects.
Each KXMLGUIClient represents a part of the GUI, composed from containers and
actions. KXMLGUIFactory takes care of building (with the help of a KXMLGUIBuilder)
and merging the GUI from an unlimited number of clients.
Each client provides XML through a QDomDocument and actions through a
KActionCollection . The XML document contains the rules for how to merge the
GUI.
KXMLGUIFactory processes the DOM tree provided by a client and plugs in the client's actions,
according to the XML and the merging rules of previously inserted clients. Container widgets
are built via a KXMLGUIBuilder , which has to be provided with the KXMLGUIFactory constructor.
See KXMLGUIFactorySignals
for signals emitted by KXMLGUIFactory
Field Summary |
---|
Fields inherited from class org.kde.qt.Qt |
---|
AlignAuto, AlignBottom, AlignCenter, AlignHCenter, AlignHorizontal_Mask, AlignJustify, AlignLeft, AlignRight, AlignTop, AlignVCenter, AlignVertical_Mask, AlphaDither_Mask, ALT, AltButton, AnchorHref, AnchorName, AndNotROP, AndROP, ArrowCursor, Ascending, ASCII_ACCEL, AutoColor, AutoDither, AutoText, AvoidDither, BDiagPattern, BeginsWith, BevelJoin, BitmapCursor, BlankCursor, Bottom, BottomLeft, BottomRight, BreakAnywhere, BusyCursor, CaseSensitive, ClearROP, ColorMode_Mask, ColorOnly, Contains, ControlButton, CopyROP, CrossCursor, CrossPattern, CTRL, CustomPattern, DashDotDotLine, DashDotLine, DashLine, Dense1Pattern, Dense2Pattern, Dense3Pattern, Dense4Pattern, Dense5Pattern, Dense6Pattern, Dense7Pattern, Descending, DiagCrossPattern, DiffuseAlphaDither, DiffuseDither, Dither_Mask, DitherMode_Mask, DockBottom, DockLeft, DockMinimized, DockRight, DockTop, DockTornOff, DockUnmanaged, DontClip, DontPrint, DotLine, DownArrow, EndsWith, EraseROP, ExactMatch, ExpandTabs, FDiagPattern, FixedColor, FixedPixmap, FlatCap, ForbiddenCursor, HiEnglishUnit, HiMetricUnit, Horizontal, HorPattern, IbeamCursor, Identical, IncludeTrailingSpaces, ISODate, Key_0, Key_1, Key_2, Key_3, Key_4, Key_5, Key_6, Key_7, Key_8, Key_9, Key_A, Key_aacute, Key_Aacute, Key_acircumflex, Key_Acircumflex, Key_acute, Key_adiaeresis, Key_Adiaeresis, Key_ae, Key_AE, Key_agrave, Key_Agrave, Key_Alt, Key_Ampersand, Key_Any, Key_Apostrophe, Key_aring, Key_Aring, Key_AsciiCircum, Key_AsciiTilde, Key_Asterisk, Key_At, Key_atilde, Key_Atilde, Key_B, Key_Back, Key_Backslash, Key_Backspace, Key_BackSpace, Key_Backtab, Key_BackTab, Key_Bar, Key_BassBoost, Key_BassDown, Key_BassUp, Key_BraceLeft, Key_BraceRight, Key_BracketLeft, Key_BracketRight, Key_brokenbar, Key_C, Key_CapsLock, Key_ccedilla, Key_Ccedilla, Key_cedilla, Key_cent, Key_Clear, Key_Colon, Key_Comma, Key_Control, Key_copyright, Key_currency, Key_D, Key_degree, Key_Delete, Key_diaeresis, Key_Direction_L, Key_Direction_R, Key_division, Key_Dollar, Key_Down, Key_E, Key_eacute, Key_Eacute, Key_ecircumflex, Key_Ecircumflex, Key_ediaeresis, Key_Ediaeresis, Key_egrave, Key_Egrave, Key_End, Key_Enter, Key_Equal, Key_Escape, Key_eth, Key_ETH, Key_Exclam, Key_exclamdown, Key_F, Key_F1, Key_F10, Key_F11, Key_F12, Key_F13, Key_F14, Key_F15, Key_F16, Key_F17, Key_F18, Key_F19, Key_F2, Key_F20, Key_F21, Key_F22, Key_F23, Key_F24, Key_F25, Key_F26, Key_F27, Key_F28, Key_F29, Key_F3, Key_F30, Key_F31, Key_F32, Key_F33, Key_F34, Key_F35, Key_F4, Key_F5, Key_F6, Key_F7, Key_F8, Key_F9, Key_Favorites, Key_Forward, Key_G, Key_Greater, Key_guillemotleft, Key_guillemotright, Key_H, Key_Help, Key_Home, Key_HomePage, Key_Hyper_L, Key_Hyper_R, Key_hyphen, Key_I, Key_iacute, Key_Iacute, Key_icircumflex, Key_Icircumflex, Key_idiaeresis, Key_Idiaeresis, Key_igrave, Key_Igrave, Key_Insert, Key_J, Key_K, Key_L, Key_Launch0, Key_Launch1, Key_Launch2, Key_Launch3, Key_Launch4, Key_Launch5, Key_Launch6, Key_Launch7, Key_Launch8, Key_Launch9, Key_LaunchA, Key_LaunchB, Key_LaunchC, Key_LaunchD, Key_LaunchE, Key_LaunchF, Key_LaunchMail, Key_LaunchMedia, Key_Left, Key_Less, Key_M, Key_macron, Key_masculine, Key_MediaLast, Key_MediaNext, Key_MediaPlay, Key_MediaPrev, Key_MediaRecord, Key_MediaStop, Key_Menu, Key_Meta, Key_Minus, Key_mu, Key_multiply, Key_N, Key_Next, Key_nobreakspace, Key_notsign, Key_ntilde, Key_Ntilde, Key_NumberSign, Key_NumLock, Key_O, Key_oacute, Key_Oacute, Key_ocircumflex, Key_Ocircumflex, Key_odiaeresis, Key_Odiaeresis, Key_ograve, Key_Ograve, Key_onehalf, Key_onequarter, Key_onesuperior, Key_Ooblique, Key_OpenUrl, Key_ordfeminine, Key_oslash, Key_otilde, Key_Otilde, Key_P, Key_PageDown, Key_PageUp, Key_paragraph, Key_ParenLeft, Key_ParenRight, Key_Pause, Key_Percent, Key_Period, Key_periodcentered, Key_Plus, Key_plusminus, Key_Print, Key_Prior, Key_Q, Key_Question, Key_questiondown, Key_QuoteDbl, Key_QuoteLeft, Key_R, Key_Refresh, Key_registered, Key_Return, Key_Right, Key_S, Key_ScrollLock, Key_Search, Key_section, Key_Semicolon, Key_Shift, Key_Slash, Key_Space, Key_ssharp, Key_Standby, Key_sterling, Key_Stop, Key_Super_L, Key_Super_R, Key_SysReq, Key_T, Key_Tab, Key_thorn, Key_THORN, Key_threequarters, Key_threesuperior, Key_TrebleDown, Key_TrebleUp, Key_twosuperior, Key_U, Key_uacute, Key_Uacute, Key_ucircumflex, Key_Ucircumflex, Key_udiaeresis, Key_Udiaeresis, Key_ugrave, Key_Ugrave, Key_Underscore, Key_unknown, Key_Up, Key_V, Key_VolumeDown, Key_VolumeMute, Key_VolumeUp, Key_W, Key_X, Key_Y, Key_yacute, Key_Yacute, Key_ydiaeresis, Key_yen, Key_Z, KeyButtonMask, Keypad, LastCursor, LastROP, Left, LeftArrow, LeftButton, LocalDate, LocalTime, LoEnglishUnit, LogText, LoMetricUnit, MacStyle, META, MetaButton, MidButton, Minimized, MiterJoin, MODIFIER_MASK, MonoOnly, MotifStyle, MouseButtonMask, MPenCapStyle, MPenJoinStyle, MPenStyle, MV_10_DOT_0, MV_10_DOT_1, MV_10_DOT_2, MV_10_DOT_3, MV_10_DOT_4, MV_9, MV_CHEETAH, MV_JAGUAR, MV_PANTHER, MV_PUMA, MV_TIGER, MV_Unknown, NandROP, NoAccel, NoAlpha, NoBackground, NoBrush, NoButton, NoMatch, NoPen, NopROP, NorROP, NotAndROP, NotCopyROP, NotEraseROP, NotOrROP, NotROP, NotXorROP, OpaqueMode, OrderedAlphaDither, OrderedDither, OrNotROP, OrROP, Overline, PaletteBackground, PaletteBase, PaletteBrightText, PaletteButton, PaletteButtonText, PaletteDark, PaletteForeground, PaletteHighlight, PaletteHighlightedText, PaletteLight, PaletteLink, PaletteLinkVisited, PaletteMid, PaletteMidlight, PaletteShadow, PaletteText, PartialMatch, PixelUnit, PlainText, PMStyle, PointingHandCursor, PreferDither, RichText, Right, RightArrow, RightButton, RoundCap, RoundJoin, SetROP, SHIFT, ShiftButton, ShowPrefix, SingleLine, SizeAllCursor, SizeBDiagCursor, SizeFDiagCursor, SizeHorCursor, SizeVerCursor, SolidLine, SolidPattern, SplitHCursor, SplitVCursor, SquareCap, StrikeOut, TextDate, ThresholdAlphaDither, ThresholdDither, Top, TopLeft, TopRight, TornOff, TransparentMode, TwipsUnit, UI_AnimateCombo, UI_AnimateMenu, UI_AnimateToolBox, UI_AnimateTooltip, UI_FadeMenu, UI_FadeTooltip, UI_General, Underline, UNICODE_ACCEL, Unmanaged, UpArrow, UpArrowCursor, UTC, VerPattern, Vertical, WaitCursor, WDestructiveClose, WGroupLeader, WhatsThisCursor, Win3Style, WindowActive, WindowFullScreen, WindowMaximized, WindowMinimized, WindowNoState, WindowsStyle, WMacDrawer, WMacNoSheet, WMouseNoMask, WNoAutoErase, WNoMousePropagation, WNorthWestGravity, WordBreak, WPaintClever, WPaintDesktop, WPaintUnclipped, WRepaintNoErase, WResizeNoErase, WShowModal, WState_AutoMask, WState_BlockUpdates, WState_CompressKeys, WState_ConfigPending, WState_Created, WState_CreatedHidden, WState_Disabled, WState_DND, WState_Exposed, WState_ForceDisabled, WState_ForceHide, WState_FullScreen, WState_HasMouse, WState_InPaintEvent, WState_Maximized, WState_Minimized, WState_MouseTracking, WState_OwnCursor, WState_OwnSizePolicy, WState_Polished, WState_Reparented, WState_Reserved0, WState_Resized, WState_Visible, WStaticContents, WStyle_ContextHelp, WStyle_Customize, WStyle_Dialog, WStyle_DialogBorder, WStyle_Mask, WStyle_Maximize, WStyle_Minimize, WStyle_MinMax, WStyle_NoBorder, WStyle_NoBorderEx, WStyle_NormalBorder, WStyle_Reserved, WStyle_Splash, WStyle_StaysOnTop, WStyle_SysMenu, WStyle_Title, WStyle_Tool, WSubWindow, WType_Desktop, WType_Dialog, WType_Mask, WType_Modal, WType_Popup, WType_TopLevel, WV_2000, WV_2003, WV_32s, WV_95, WV_98, WV_CE, WV_CE_based, WV_CENET, WV_DOS_based, WV_Me, WV_NT, WV_NT_based, WV_XP, WWinOwnDC, WX11BypassWM, X11ParentRelative, XorROP |
Constructor Summary | |
---|---|
protected |
KXMLGUIFactory(java.lang.Class dummy)
|
|
KXMLGUIFactory(KXMLGUIBuilderInterface builder)
|
|
KXMLGUIFactory(KXMLGUIBuilderInterface builder,
org.kde.qt.QObject parent)
|
|
KXMLGUIFactory(KXMLGUIBuilderInterface builder,
org.kde.qt.QObject parent,
java.lang.String name)
Constructs a KXMLGUIFactory. |
Method Summary | |
---|---|
static org.kde.qt.QDomElement |
actionPropertiesElement(org.kde.qt.QDomDocument doc)
Find or create the ActionProperties element, used when saving custom action properties |
void |
addClient(KXMLGUIClientInterface client)
Creates the GUI described by the QDomDocument of the client, using the client's actions, and merges it with the previously created GUI. |
java.lang.String |
className()
|
int |
configureShortcuts()
|
int |
configureShortcuts(boolean bAllowLetterShortcuts)
|
int |
configureShortcuts(boolean bAllowLetterShortcuts,
boolean bSaveSettings)
Show a standard configure shortcut for every action in this factory. |
org.kde.qt.QWidget |
container(java.lang.String containerName,
KXMLGUIClientInterface client)
|
org.kde.qt.QWidget |
container(java.lang.String containerName,
KXMLGUIClientInterface client,
boolean useTagName)
Use this method to get access to a container widget with the name specified with containerName
and which is owned by the client. The container name is specified with a "name" attribute in the
XML document. |
void |
dispose()
Delete the wrapped C++ instance ahead of finalize() |
static java.lang.String |
documentToXML(org.kde.qt.QDomDocument doc)
|
static java.lang.String |
elementToXML(org.kde.qt.QDomElement elem)
|
protected void |
finalize()
Deletes the wrapped C++ instance |
static org.kde.qt.QDomElement |
findActionByName(org.kde.qt.QDomElement elem,
java.lang.String sName,
boolean create)
Find or create the element for a given action, by name. |
boolean |
isDisposed()
Has the wrapped C++ instance been deleted? |
org.kde.qt.QMetaObject |
metaObject()
|
static java.lang.String |
readConfigFile(java.lang.String filename)
|
static java.lang.String |
readConfigFile(java.lang.String filename,
boolean never_null)
|
static java.lang.String |
readConfigFile(java.lang.String filename,
boolean never_null,
KInstanceInterface instance)
|
static java.lang.String |
readConfigFile(java.lang.String filename,
KInstanceInterface instance)
|
void |
removeClient(KXMLGUIClientInterface client)
Removes the GUI described by the client, by unplugging all provided actions and removing all owned containers (and storing container state information in the given client) |
static void |
removeDOMComments(org.kde.qt.QDomNode node)
Removes all QDomComment objects from the specified node and all its children. |
void |
reset()
Use this method to free all memory allocated by the KXMLGUIFactory. |
void |
resetContainer(java.lang.String containerName)
|
void |
resetContainer(java.lang.String containerName,
boolean useTagName)
Use this method to free all memory allocated by the KXMLGUIFactory for a specific container, including all child containers and actions. |
static boolean |
saveConfigFile(org.kde.qt.QDomDocument doc,
java.lang.String filename)
|
static boolean |
saveConfigFile(org.kde.qt.QDomDocument doc,
java.lang.String filename,
KInstanceInterface instance)
|
void |
unplugActionList(KXMLGUIClientInterface client,
java.lang.String name)
|
Methods inherited from class org.kde.qt.QObject |
---|
activate_filters, activate_signal_bool, activate_signal, activate_signal, activate_signal, activate_signal, blockSignals, checkConnectArgs, child, child, child, childEvent, children, connect, connect, connectInternal, connectNotify, customEvent, deleteLater, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnectInternal, disconnectNotify, dumpObjectInfo, dumpObjectTree, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, event, eventFilter, highPriority, i18n, inherits, insertChild, installEventFilter, isA, isWidgetType, killTimer, killTimers, name, name, normalizeSignalSlot, objectTrees, parent, property, queryList, queryList, queryList, queryList, queryList, registerUserData, removeChild, removeEventFilter, sender, setName, setProperty, signalsBlocked, startTimer, timerEvent, tr, tr |
Methods inherited from class org.kde.qt.Qt |
---|
arrowCursor, bin, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, black, blankCursor, blue, color0, color1, copyBlt, copyBlt, copyBlt, copyBlt, copyBlt, crossCursor, cyan, darkBlue, darkCyan, darkGray, darkGreen, darkMagenta, darkRed, darkYellow, dec, dynamicCast, endl, flush, forbiddenCursor, fromUtf8, gray, green, hex, ibeamCursor, lightGray, magenta, oct, op_div, op_div, op_div, op_div, op_equals, op_equals, op_equals, op_equals, op_minus, op_minus, op_minus, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_not_equals, op_not_equals, op_not_equals, op_not_equals, op_plus, op_plus, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, pointingHandCursor, qAlpha, qApp, qAppName, qBlue, qCompress, qCompress, qDebug, qDebug, qDrawArrow, qDrawItem, qDrawItem, qDrawItem, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qFatal, qFatal, qGLVersion, qGray, qGray, qGreen, qInitNetworkProtocols, qInstallPath, qInstallPathBins, qInstallPathData, qInstallPathDocs, qInstallPathHeaders, qInstallPathLibs, qInstallPathPlugins, qInstallPathSysconf, qInstallPathTranslations, qItemRect, qItemRect, qObsolete, qObsolete, qObsolete, qRed, qRgb, qRgba, qRound, qSharedBuild, qSuppressObsoleteWarnings, qSuppressObsoleteWarnings, qSysInfo, qSystemWarning, qSystemWarning, qUncompress, qUncompress, qVersion, qWarning, qWarning, red, reset, SIGNAL, sizeAllCursor, sizeBDiagCursor, sizeFDiagCursor, sizeHorCursor, sizeVerCursor, SLOT, splitHCursor, splitVCursor, upArrowCursor, waitCursor, whatsThisCursor, white, ws, yellow |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected KXMLGUIFactory(java.lang.Class dummy)
public KXMLGUIFactory(KXMLGUIBuilderInterface builder, org.kde.qt.QObject parent, java.lang.String name)
builder
KXMLGUIBuilder will be called
for creating and removing container widgets, when clients are added/removed from the GUI.
Note that the ownership of the given KXMLGUIBuilder object won't be transferred to this
KXMLGUIFactory, so you have to take care of deleting it properly.
public KXMLGUIFactory(KXMLGUIBuilderInterface builder, org.kde.qt.QObject parent)
public KXMLGUIFactory(KXMLGUIBuilderInterface builder)
Method Detail |
---|
public org.kde.qt.QMetaObject metaObject()
metaObject
in class org.kde.qt.QObject
public java.lang.String className()
className
in class org.kde.qt.QObject
public void addClient(KXMLGUIClientInterface client)
public void removeClient(KXMLGUIClientInterface client)
public void unplugActionList(KXMLGUIClientInterface client, java.lang.String name)
public org.kde.qt.QWidget container(java.lang.String containerName, KXMLGUIClientInterface client, boolean useTagName)
containerName
and which is owned by the client.
The container name is specified with a "name" attribute in the
XML document.
This function is particularly useful for getting hold of a popupmenu defined in an XMLUI file.
For instance:
QPopupMenu popup = (QPopupMenu)(factory().container("my_popup",this));where
"my_popup" is the name of the menu in the XMLUI file, and
"this" is XMLGUIClient which owns the popupmenu (e.g. the mainwindow, or the part, or the plugin...)
containerName
- Name of the container widgetclient
- Owner of the container widgetuseTagName
- Specifies whether to compare the specified name with the name attribute or
the tag name.
This method may return null if no container with the given name exists or is not owned by the client.public org.kde.qt.QWidget container(java.lang.String containerName, KXMLGUIClientInterface client)
public void reset()
public void resetContainer(java.lang.String containerName, boolean useTagName)
public void resetContainer(java.lang.String containerName)
public int configureShortcuts(boolean bAllowLetterShortcuts, boolean bSaveSettings)
KStdAction.keyBindings( guiFactory(), SLOT("configureShortcuts()"), actionCollection() );
bAllowLetterShortcuts
- Set to false if unmodified alphanumeric
keys ('A', '1', etc.) are not permissible shortcuts.bSaveSettings
- if true, the settings will also be saved back to
the uirc file which they were intially read from.public int configureShortcuts(boolean bAllowLetterShortcuts)
public int configureShortcuts()
public static java.lang.String readConfigFile(java.lang.String filename, boolean never_null, KInstanceInterface instance)
public static java.lang.String readConfigFile(java.lang.String filename, boolean never_null)
public static java.lang.String readConfigFile(java.lang.String filename, KInstanceInterface instance)
public static java.lang.String readConfigFile(java.lang.String filename)
public static boolean saveConfigFile(org.kde.qt.QDomDocument doc, java.lang.String filename, KInstanceInterface instance)
public static boolean saveConfigFile(org.kde.qt.QDomDocument doc, java.lang.String filename)
public static java.lang.String documentToXML(org.kde.qt.QDomDocument doc)
public static java.lang.String elementToXML(org.kde.qt.QDomElement elem)
public static void removeDOMComments(org.kde.qt.QDomNode node)
public static org.kde.qt.QDomElement actionPropertiesElement(org.kde.qt.QDomDocument doc)
public static org.kde.qt.QDomElement findActionByName(org.kde.qt.QDomElement elem, java.lang.String sName, boolean create)
protected void finalize() throws java.lang.InternalError
finalize
in class org.kde.qt.QObject
java.lang.InternalError
public void dispose()
dispose
in class org.kde.qt.QObject
public boolean isDisposed()
isDisposed
in class org.kde.qt.QObject
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |