summaryrefslogtreecommitdiffstats
path: root/libkonq/konq_xmlguiclient.h
blob: 5696573da3f4f0ba4d277702877a2889f68cdc9c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
/* This file is part of the KDE project
   Copyright (C) 2001 Holger Freyther <[email protected]>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

#ifndef __konqxmlguiclient_h
#define __konqxmlguiclient_h

#include <sys/types.h>

#include <tdeaction.h>
#include <kxmlguiclient.h>
#include <tqstringlist.h>
#include <libkonq_export.h>

/**
 * This class implements common methods to manipulate the DOMDocument of KXMLGUIClient
 *
 */
class LIBKONQ_EXPORT KonqXMLGUIClient : public KXMLGUIClient
{
public:
  KonqXMLGUIClient();
  KonqXMLGUIClient(KXMLGUIClient *parent);
  virtual ~KonqXMLGUIClient();
  /**
   * Reimplemented for internal purpose
   */
  TQDomDocument domDocument() const;
  TQDomElement  DomElement() const; // KDE4: s/D/d/

  // @return true if the group named "name" exists
  bool hasGroup(const TQString &name) const;

protected:
  void addAction(TDEAction *action, const TQDomElement &menu = TQDomElement());
  void addAction(const char *name, const TQDomElement &menu = TQDomElement());
  void addSeparator(const TQDomElement &menu = TQDomElement());
  /// only add a separator if an action is added afterwards
  void addPendingSeparator();
  void addGroup(const TQString &grp);
  void addMerge(const TQString &name);

  // @return true if addAction was called at least once
  bool hasAction() const;
  void prepareXMLGUIStuff();

// KDE4: make private
  TQDomElement m_menuElement;
  TQDomDocument m_doc;

private:
  void handlePendingSeparator();
  class Private;
  Private *d;
};
#endif