summaryrefslogtreecommitdiffstats
path: root/kmymoney2/widgets/kmymoneycategory.h
diff options
context:
space:
mode:
authortpearson <tpearson@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2011-07-04 22:38:03 +0000
committertpearson <tpearson@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2011-07-04 22:38:03 +0000
commitdadc34655c3ab961b0b0b94a10eaaba710f0b5e8 (patch)
tree99e72842fe687baea16376a147619b6048d7e441 /kmymoney2/widgets/kmymoneycategory.h
downloadkmymoney-dadc34655c3ab961b0b0b94a10eaaba710f0b5e8.tar.gz
kmymoney-dadc34655c3ab961b0b0b94a10eaaba710f0b5e8.zip
Added kmymoney
git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/applications/kmymoney@1239792 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'kmymoney2/widgets/kmymoneycategory.h')
-rw-r--r--kmymoney2/widgets/kmymoneycategory.h196
1 files changed, 196 insertions, 0 deletions
diff --git a/kmymoney2/widgets/kmymoneycategory.h b/kmymoney2/widgets/kmymoneycategory.h
new file mode 100644
index 0000000..474062d
--- /dev/null
+++ b/kmymoney2/widgets/kmymoneycategory.h
@@ -0,0 +1,196 @@
+/***************************************************************************
+ kmymoneycategory.h
+ -------------------
+ begin : Mon Jul 10 2006
+ copyright : (C) 2006 by Thomas Baumgart
+ email : Thomas Baumgart <ipwizard@users.sourceforge.net>
+ ***************************************************************************/
+
+/***************************************************************************
+ * *
+ * This program is free software; you can redistribute it and/or modify *
+ * it under the terms of the GNU General Public License as published by *
+ * the Free Software Foundation; either version 2 of the License, or *
+ * (at your option) any later version. *
+ * *
+ ***************************************************************************/
+
+#ifndef KMYMONEYCATEGORY_H
+#define KMYMONEYCATEGORY_H
+
+// ----------------------------------------------------------------------------
+// QT Includes
+
+class QWidget;
+class QFrame;
+
+// ----------------------------------------------------------------------------
+// KDE Includes
+
+#include "kdecompat.h"
+#include <kcombobox.h>
+class KPushButton;
+
+// ----------------------------------------------------------------------------
+// Project Includes
+
+#include <kmymoney/mymoneyaccount.h>
+#include <kmymoney/kmymoneycombo.h>
+
+class kMyMoneyAccountSelector;
+
+/**
+ * This class implements a text based account/category selector.
+ * When initially used, the widget has the functionality of a KComboBox object.
+ * Whenever a key is pressed, the set of loaded accounts is searched for
+ * accounts which match the currently entered text.
+ *
+ * If any match is found a list selection box is opened and the user can use
+ * the up/down, page-up/page-down keys or the mouse to navigate in the list. If
+ * an account is selected, the selection box is closed. Other key-strokes are
+ * directed to the parent object to manipulate the text. The visible contents of
+ * the selection box is updated with every key-stroke.
+ *
+ * This object is a replacement of the kMyMoneyCategory object and should be used
+ * for new code.
+ *
+ * @author Thomas Baumgart
+ */
+class KMyMoneyCategory : public KMyMoneyCombo
+{
+ Q_OBJECT
+public:
+ /**
+ * Standard constructor for the account selection object.
+ *
+ * If parameter @a splitButton is @a true, the widget
+ * will construct a surrounding QFrame and reparent itself to be a child of this
+ * QFrame. It also adds a KPushButton with the "Split" icon to the right of the
+ * input field. In this case it is important not to use the pointer to this widget
+ * but it's parent when placing the object in a QLayout, QTable or some such. The
+ * parent widget (the QFrame in this case) can be extracted with the parentWidget()
+ * method.
+ *
+ * Reparenting is handled by the object transparently for both cases.
+ *
+ * Standard usage example (no split button):
+ *
+ * @code
+ * KMyMoneyCategory* category = new KMyMoneyCategory;
+ * category->reparent(newParent);
+ * layout->addWidget(category);
+ * table->setCellWidget(category);
+ * @endcode
+ *
+ * Enhanced usage example (with split button):
+ *
+ * @code
+ * KMyMoneyCategory* category = new KMyMoneyCategory(0, 0, true);
+ * category->reparent(newParent);
+ * layout->addWidget(category->parentWidget());
+ * table->setCellWidget(category->parentWidget());
+ * @endcode
+ */
+ KMyMoneyCategory(QWidget* parent = 0, const char* name = 0, bool splitButton = false);
+
+ virtual ~KMyMoneyCategory();
+
+ /**
+ * This member returns a pointer to the completion object.
+ *
+ * @return pointer to completion's selector object
+ */
+ kMyMoneyAccountSelector* selector(void) const;
+
+ /**
+ * This member returns a pointer to the split button. In case the @a splitButton parameter
+ * of the constructor was @a false, this method prints a warning to stderr and returns 0.
+ */
+ KPushButton* splitButton(void) const;
+
+ /**
+ * Reimplemented for internal reasons. No API change
+ */
+ virtual void reparent( QWidget *parent, WFlags, const QPoint &, bool showIt = FALSE );
+
+ /**
+ * Reimplemented for internal reasons. No API change.
+ */
+ virtual void setPalette(const QPalette& palette);
+
+ /**
+ * Force the text field to show the text for split transaction.
+ */
+ void setSplitTransaction(void);
+
+ /**
+ * Check if the text field contains the text for a split transaction
+ */
+ bool isSplitTransaction(void) const;
+
+ /**
+ * overridden for internal reasons, no API change
+ */
+ void setCurrentText(const QString& txt = QString()) { KMyMoneyCombo::setCurrentText(txt); }
+
+protected:
+ /**
+ * Reimplemented to support protected category text ("split transactions")
+ *
+ * @sa focusIn()
+ */
+ virtual void focusInEvent(QFocusEvent* ev);
+
+ /**
+ * Reimplemented to support protected category text ("split transactions")
+ */
+ virtual void focusOutEvent(QFocusEvent* ev);
+
+ /**
+ * set the widgets text area based on the item with the given @a id.
+ */
+ virtual void setCurrentTextById(const QString& id);
+
+public slots:
+ virtual void slotItemSelected(const QString& id);
+ virtual void setEnabled(bool);
+ virtual void setDisabled(bool);
+
+signals:
+ /**
+ * Signal to inform other objects that this object has reached focus.
+ * Used for e.g. to open the split dialog when the focus reaches this
+ * object and it contains the text 'Split transaction'.
+ *
+ * @sa focusInEvent()
+ */
+ void focusIn(void);
+
+private:
+ /// \internal d-pointer class.
+ class Private;
+ /// \internal d-pointer instance.
+ Private* const d;
+};
+
+
+class KMyMoneySecurity : public KMyMoneyCategory
+{
+ Q_OBJECT
+public:
+ KMyMoneySecurity(QWidget* parent = 0, const char* name = 0);
+ virtual ~KMyMoneySecurity();
+
+ /**
+ * overridden for internal reasons, no API change
+ */
+ void setCurrentText(const QString& txt = QString()) { KMyMoneyCategory::setCurrentText(txt); }
+
+protected:
+ /**
+ * set the widgets text area based on the item with the given @a id.
+ */
+ virtual void setCurrentTextById(const QString& id);
+};
+
+#endif