WebCore/kwq/KWQListBox.h

   1 /*
   2  * Copyright (C) 2004 Apple Computer, Inc.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef KWQLISTBOX_H_
  27 #define KWQLISTBOX_H_
  28
  29 #include "KWQScrollView.h"
  30 #include "KWQSignal.h"
  31 #include "KWQString.h"
  32 #include "KWQValueList.h"
  33
  34 struct KWQListBoxItem
  35 {
  36     QString string;
  37     bool isGroupLabel;
  38
  39     KWQListBoxItem(const QString &s, bool isLabel) : string(s), isGroupLabel(isLabel) { }
  40 };
  41
  42 class QListBox : public QScrollView {
  43 public:
  44     enum SelectionMode { Single, Extended };
  45
  46     QListBox(QWidget *parent);
  47     ~QListBox();
  48
  49     QSize sizeForNumberOfLines(int numLines) const;
  50
  51     uint count() const { return _items.count(); }
  52
  53     void setSelectionMode(SelectionMode);
  54
  55     void clear();
  56     void appendItem(const QString &s) { appendItem(s, false); }
  57     void appendGroupLabel(const QString &s) { appendItem(s, true); }
  58     void doneAppendingItems();
  59
  60     void setSelected(int, bool);
  61     bool isSelected(int) const;
  62
  63     void setEnabled(bool enabled);
  64     bool isEnabled();
  65
  66     const KWQListBoxItem &itemAtIndex(int index) const { return _items[index]; }
  67
  68     void setWritingDirection(QPainter::TextDirection);
  69
  70     bool changingSelection() { return _changingSelection; }
  71     void clicked() { _clicked.call(); }
  72     void selectionChanged() { _selectionChanged.call(); }
  73
  74     virtual FocusPolicy focusPolicy() const;
  75     virtual bool checksDescendantsForFocus() const;
  76
  77 private:
  78     void appendItem(const QString &, bool isLabel);
  79
  80     // A vector<QString> or QValueVector<QString> might be more efficient for large lists.
  81     QValueList<KWQListBoxItem> _items;
  82
  83     bool _changingSelection;
  84     bool _enabled;
  85
  86     mutable float _width;
  87     mutable bool _widthGood;
  88
  89     KWQSignal _clicked;
  90     KWQSignal _selectionChanged;
  91 };
  92
  93 #endif