OpendTect-6_4  6.4
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Friends | List of all members
uiTreeView Class Reference
Inheritance diagram for uiTreeView:
[legend]

Public Types

enum  WidthMode {
  Manual, Fixed, Stretch, ResizeToContents,
  Custom
}
 
enum  ScrollMode { Auto, AlwaysOff, AlwaysOn }
 
enum  SelectionMode {
  NoSelection =0, Single, Multi, Extended,
  Contiguous
}
 
enum  SelectionBehavior { SelectItems, SelectRows, SelectColumns }
 
- Public Types inherited from uiObject
enum  SzPolicy {
  Undef, Small, Medium, Wide,
  SmallVar, MedVar, WideVar, SmallMax,
  MedMax, WideMax
}
 How should the object's size behave? Undef : use default. Small : 1 base sz. Medium : 2* base sz + 1. Wide : 4* base sz + 3. The xxVar options specify that the element may have a bigger internal preferred size. In that case, the maximum is taken. The xxMax options specify that the element should take all available space ( stretch = 2 ) More...
 

Public Member Functions

 uiTreeView (uiParent *parnt, const char *nm="uiTreeView", int preferredNrLines=0, bool rootdecorated=true)
 
virtual ~uiTreeView ()
 
void setEmpty ()
 
void setNrLines (int)
 
bool rootDecorated () const
 
void setRootDecorated (bool yn)
 
void showHeader (bool yn)
 
void addColumns (const uiStringSet &)
 
void addColumns (const BufferStringSet &)
 
void setNrColumns (int)
 
int nrColumns () const
 
void removeColumn (int index)
 
void setColumnText (int column, const uiString &label)
 
uiString getColumnText (int column) const
 
void setColumnWidth (int column, int width)
 
void setFixedColumnWidth (int column, int width)
 
int columnWidth (int column) const
 
void setColumnWidthMode (WidthMode)
 
void setColumnWidthMode (int column, WidthMode)
 
WidthMode columnWidthMode (int column) const
 
void setColumnAlignment (Alignment::HPos)
 
void setColumnAlignment (int, Alignment::HPos)
 
Alignment::HPos columnAlignment (int) const
 
void setHScrollBarMode (ScrollMode)
 
void setVScrollBarMode (ScrollMode)
 
void setSelectionMode (SelectionMode)
 
SelectionMode selectionMode () const
 
void setSelectionBehavior (SelectionBehavior)
 
SelectionBehavior selectionBehavior () const
 
void clearSelection ()
 
void setSelected (uiTreeViewItem *, bool)
 
bool isSelected (const uiTreeViewItem *) const
 
uiTreeViewItemselectedItem () const
 
int nrSelected () const
 
void getSelectedItems (ObjectSet< uiTreeViewItem > &) const
 
void removeSelectedItems ()
 
int nrItems () const
 
void setCurrentItem (uiTreeViewItem *, int column=0)
 
uiTreeViewItemcurrentItem () const
 
int currentColumn () const
 
int indexOfItem (uiTreeViewItem *) const
 
uiTreeViewItemgetItem (int) const
 
uiTreeViewItemfirstItem () const
 
uiTreeViewItemlastItem () const
 
uiTreeViewItemfindItem (const char *, int, bool) const
 
void setItemMargin (int)
 
int itemMargin () const
 
void setShowToolTips (bool)
 
bool showToolTips () const
 
void clear ()
 
void selectAll ()
 
void deselectAll ()
 
void checkAll ()
 
void uncheckAll ()
 
void expandAll ()
 
void collapseAll ()
 
void expandTo (int treedepth)
 
void ensureItemVisible (const uiTreeViewItem *)
 
void takeItem (uiTreeViewItem *)
 
void insertItem (int, uiTreeViewItem *)
 
uiParentparent ()
 
void translateText ()
 
bool handleLongTabletPress ()
 
void triggerUpdate ()
 re-draws at next X-loop More...
 
uiTreeViewItemitemNotified ()
 item last notified. See notifiers below More...
 
int columnNotified ()
 
void unNotify ()
 
void setNotifiedItem (mQtclass(QTreeWidgetItem *))
 
void setNotifiedColumn (int col)
 
const char * columnText (int column) const
 
- Public Member Functions inherited from uiObject
 uiObject (uiParent *, const char *nm)
 
 uiObject (uiParent *, const char *nm, uiObjectBody &)
 
 ~uiObject ()
 
void setHSzPol (SzPolicy)
 
void setVSzPol (SzPolicy)
 
SzPolicy szPol (bool hor=true) const
 
virtual int width () const
 Actual size in pixels. More...
 
virtual int height () const
 Actual size in pixels. More...
 
virtual void setName (const char *)
 
void setToolTip (const uiString &)
 
const uiStringtoolTip () const
 
void translateText ()
 
void display (bool yn, bool shrink=false, bool maximized=false)
 
void setFocus ()
 
bool hasFocus () const
 
void disabFocus ()
 
virtual void setCursor (const MouseCursor &)
 
bool isCursorInside () const
 
virtual void setStyleSheet (const char *)
 
virtual Color backgroundColor () const
 
Color roBackgroundColor () const
 
virtual void setBackgroundColor (const Color &)
 
virtual void setBackgroundPixmap (const uiPixmap &)
 
virtual void setTextColor (const Color &)
 
void setSensitive (bool yn=true)
 
bool sensitive () const
 
bool visible () const
 
bool isDisplayed () const
 
int prefHNrPics () const
 
virtual void setPrefWidth (int)
 
void setPrefWidthInChar (int)
 
void setPrefWidthInChar (float)
 
void setMinimumWidth (int)
 
void setMaximumWidth (int)
 
int prefVNrPics () const
 
virtual void setPrefHeight (int)
 
void setPrefHeightInChar (int)
 
void setPrefHeightInChar (float)
 
void setMinimumHeight (int)
 
void setMaximumHeight (int)
 
void setStretch (int hor, int ver)
 Sets stretch factors for object If stretch factor is > 1, then object will already grow at pop-up. More...
 
void attach (constraintType, int margin=-1)
 attaches object to another In case the stretched... options are used, margin=-1 (default) stretches the object not to cross the border. margin=-2 stretches the object to fill the parent's border. This looks nice with separators. More...
 
void attach (constraintType, uiObject *, int margin=-1, bool reciprocal=true)
 
void attach (constraintType, uiParent *, int margin=-1, bool reciprocal=true)
 
void setFont (const uiFont &)
 
const uiFontfont () const
 
void setCaption (const uiString &)
 
void shallowRedraw (CallBacker *=0)
 
void deepRedraw (CallBacker *=0)
 
void reDraw (bool deep)
 
uiSize actualsize (bool include_border=true) const
 
uiParentparent ()
 
const uiParentparent () const
 
void reParent (uiParent *)
 
uiMainWinmainwin ()
 
 mQtclass (QWidget *) getWidget()
 
 mQtclass (QWidget *) qwidget()
 
const mQtclass (QWidget *) qwidget() const
 
virtual const ObjectSet< uiBaseObject > * childList () const
 
void close ()
 

Public Attributes

Notifier< uiTreeViewselectionChanged
 
Notifier< uiTreeViewcurrentChanged
 
Notifier< uiTreeViewitemChanged
 
Notifier< uiTreeViewitemRenamed
 
Notifier< uiTreeViewreturnPressed
 
Notifier< uiTreeViewrightButtonClicked
 
Notifier< uiTreeViewrightButtonPressed
 
Notifier< uiTreeViewleftButtonClicked
 
Notifier< uiTreeViewleftButtonPressed
 
Notifier< uiTreeViewmouseButtonPressed
 
Notifier< uiTreeViewmouseButtonClicked
 
Notifier< uiTreeViewcontextMenuRequested
 
Notifier< uiTreeViewdoubleClicked
 
Notifier< uiTreeViewexpanded
 
Notifier< uiTreeViewcollapsed
 
Notifier< uiTreeViewunusedKey
 
- Public Attributes inherited from uiObject
Notifier< uiObjectclosed
 Triggered when object closes. More...
 
CNotifier< uiObject, uiRect & > setGeometry
 triggered when getting a new geometry A reference to the new geometry is passed which can be manipulated, before the geometry is actually set to the QWidget. More...
 

Protected Member Functions

bool allowDoubleClick () const
 
void cursorSelectionChanged (CallBacker *)
 
void itemChangedCB (CallBacker *)
 
void updateCheckStatus (uiTreeViewItem *)
 
uiTreeViewBodylvbody ()
 
const uiTreeViewBodylvbody () const
 
void updateHeaderLabels ()
 
- Protected Member Functions inherited from uiObject
virtual bool closeOK ()
 hook. Accepts/denies closing of window. More...
 
void triggerSetGeometry (const i_LayoutItem *, uiRect &)
 setGeometry should be triggered by this's layoutItem More...
 
void updateToolTip (CallBacker *=0)
 

Protected Attributes

BufferString rettxt
 
uiTreeViewItemlastitemnotified_
 
uiParentparent_
 
int column_
 
OD::ButtonState buttonstate_
 
- Protected Attributes inherited from uiObject
uiString tooltip_
 
uiObjEventFilter * uiobjeventfilter_
 

Private Member Functions

 mODTextTranslationClass (uiTreeView)
 
uiTreeViewBodymkbody (uiParent *, const char *, int)
 

Private Attributes

uiTreeViewBodybody_
 
uiStringSet labels_
 

Friends

class i_treeVwMessenger
 
class uiTreeViewBody
 
class uiTreeViewItem
 
class uiTreeViewItemIterator
 

Additional Inherited Members

- Static Public Member Functions inherited from uiObject
static void updateToolTips ()
 
static void setTabOrder (uiObject *first, uiObject *second)
 
static int baseFldSize ()
 
static int iconSize ()
 

Detailed Description

Member Enumeration Documentation

Enumerator
Auto 
AlwaysOff 
AlwaysOn 
Enumerator
SelectItems 
SelectRows 
SelectColumns 
Enumerator
NoSelection 
Single 
Multi 
Extended 
Contiguous 
Enumerator
Manual 
Fixed 
Stretch 
ResizeToContents 
Custom 

Constructor & Destructor Documentation

uiTreeView::uiTreeView ( uiParent parnt,
const char *  nm = "uiTreeView",
int  preferredNrLines = 0,
bool  rootdecorated = true 
)
virtual uiTreeView::~uiTreeView ( )
virtual

Member Function Documentation

void uiTreeView::addColumns ( const uiStringSet )
void uiTreeView::addColumns ( const BufferStringSet )
bool uiTreeView::allowDoubleClick ( ) const
protected
void uiTreeView::checkAll ( )
void uiTreeView::clear ( )
void uiTreeView::clearSelection ( )
void uiTreeView::collapseAll ( )
Alignment::HPos uiTreeView::columnAlignment ( int  ) const
int uiTreeView::columnNotified ( )
inline
const char* uiTreeView::columnText ( int  column) const
int uiTreeView::columnWidth ( int  column) const
WidthMode uiTreeView::columnWidthMode ( int  column) const
int uiTreeView::currentColumn ( ) const
uiTreeViewItem* uiTreeView::currentItem ( ) const
void uiTreeView::cursorSelectionChanged ( CallBacker )
protected
void uiTreeView::deselectAll ( )
void uiTreeView::ensureItemVisible ( const uiTreeViewItem )
void uiTreeView::expandAll ( )
void uiTreeView::expandTo ( int  treedepth)
uiTreeViewItem* uiTreeView::findItem ( const char *  ,
int  ,
bool   
) const
uiTreeViewItem* uiTreeView::firstItem ( ) const
uiString uiTreeView::getColumnText ( int  column) const
uiTreeViewItem* uiTreeView::getItem ( int  ) const
void uiTreeView::getSelectedItems ( ObjectSet< uiTreeViewItem > &  ) const
bool uiTreeView::handleLongTabletPress ( )
virtual

Reimplemented from uiObject.

int uiTreeView::indexOfItem ( uiTreeViewItem ) const
void uiTreeView::insertItem ( int  ,
uiTreeViewItem  
)
bool uiTreeView::isSelected ( const uiTreeViewItem ) const
void uiTreeView::itemChangedCB ( CallBacker )
protected
int uiTreeView::itemMargin ( ) const
uiTreeViewItem* uiTreeView::itemNotified ( )
inline

item last notified. See notifiers below

uiTreeViewItem* uiTreeView::lastItem ( ) const
uiTreeViewBody* uiTreeView::lvbody ( )
inlineprotected
const uiTreeViewBody* uiTreeView::lvbody ( ) const
inlineprotected
uiTreeViewBody& uiTreeView::mkbody ( uiParent ,
const char *  ,
int   
)
private
uiTreeView::mODTextTranslationClass ( uiTreeView  )
private
int uiTreeView::nrColumns ( ) const
int uiTreeView::nrItems ( ) const
int uiTreeView::nrSelected ( ) const
uiParent* uiTreeView::parent ( )
inline
void uiTreeView::removeColumn ( int  index)
void uiTreeView::removeSelectedItems ( )
bool uiTreeView::rootDecorated ( ) const
void uiTreeView::selectAll ( )
uiTreeViewItem* uiTreeView::selectedItem ( ) const
SelectionBehavior uiTreeView::selectionBehavior ( ) const
SelectionMode uiTreeView::selectionMode ( ) const
void uiTreeView::setColumnAlignment ( Alignment::HPos  )
void uiTreeView::setColumnAlignment ( int  ,
Alignment::HPos   
)
void uiTreeView::setColumnText ( int  column,
const uiString label 
)
void uiTreeView::setColumnWidth ( int  column,
int  width 
)
void uiTreeView::setColumnWidthMode ( WidthMode  )
void uiTreeView::setColumnWidthMode ( int  column,
WidthMode   
)
void uiTreeView::setCurrentItem ( uiTreeViewItem ,
int  column = 0 
)
void uiTreeView::setEmpty ( )
void uiTreeView::setFixedColumnWidth ( int  column,
int  width 
)
void uiTreeView::setHScrollBarMode ( ScrollMode  )
void uiTreeView::setItemMargin ( int  )
void uiTreeView::setNotifiedColumn ( int  col)
inline
void uiTreeView::setNotifiedItem ( mQtclass(QTreeWidgetItem *)  )
void uiTreeView::setNrColumns ( int  )
void uiTreeView::setNrLines ( int  )
void uiTreeView::setRootDecorated ( bool  yn)
void uiTreeView::setSelected ( uiTreeViewItem ,
bool   
)
void uiTreeView::setSelectionBehavior ( SelectionBehavior  )
void uiTreeView::setSelectionMode ( SelectionMode  )
void uiTreeView::setShowToolTips ( bool  )
void uiTreeView::setVScrollBarMode ( ScrollMode  )
void uiTreeView::showHeader ( bool  yn)
bool uiTreeView::showToolTips ( ) const
void uiTreeView::takeItem ( uiTreeViewItem )
void uiTreeView::translateText ( )
void uiTreeView::triggerUpdate ( )

re-draws at next X-loop

void uiTreeView::uncheckAll ( )
void uiTreeView::unNotify ( )
inline
void uiTreeView::updateCheckStatus ( uiTreeViewItem )
protected
void uiTreeView::updateHeaderLabels ( )
protected

Friends And Related Function Documentation

friend class i_treeVwMessenger
friend
friend class uiTreeViewBody
friend
friend class uiTreeViewItem
friend
friend class uiTreeViewItemIterator
friend

Member Data Documentation

uiTreeViewBody* uiTreeView::body_
private
OD::ButtonState uiTreeView::buttonstate_
protected
Notifier<uiTreeView> uiTreeView::collapsed
int uiTreeView::column_
protected
Notifier<uiTreeView> uiTreeView::contextMenuRequested
Notifier<uiTreeView> uiTreeView::currentChanged
Notifier<uiTreeView> uiTreeView::doubleClicked
Notifier<uiTreeView> uiTreeView::expanded
Notifier<uiTreeView> uiTreeView::itemChanged
Notifier<uiTreeView> uiTreeView::itemRenamed
uiStringSet uiTreeView::labels_
private
uiTreeViewItem* uiTreeView::lastitemnotified_
protected
Notifier<uiTreeView> uiTreeView::leftButtonClicked
Notifier<uiTreeView> uiTreeView::leftButtonPressed
Notifier<uiTreeView> uiTreeView::mouseButtonClicked
Notifier<uiTreeView> uiTreeView::mouseButtonPressed
uiParent* uiTreeView::parent_
protected
BufferString uiTreeView::rettxt
mutableprotected
Notifier<uiTreeView> uiTreeView::returnPressed
Notifier<uiTreeView> uiTreeView::rightButtonClicked
Notifier<uiTreeView> uiTreeView::rightButtonPressed
Notifier<uiTreeView> uiTreeView::selectionChanged
Notifier<uiTreeView> uiTreeView::unusedKey

Generated at for the OpendTect seismic interpretation project. Copyright (C): dGB Beheer B. V. 2019