uiTextBrowser Class Reference

Inheritance diagram for uiTextBrowser:

Public Types
enum	LinkBehavior { None , FollowLocal , FollowAll }
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 Types inherited from ObjectWithName
typedef OD::String	name_type

Public Member Functions
	uiTextBrowser (uiParent *, const char *nm="File browser", int maxlns=mUdf(int), bool forceplaintext=true, bool logmode=false)
	~uiTextBrowser ()
void	backward ()
bool	canGoBackward ()
bool	canGoForward ()
void	forward ()
void	getHtmlText (BufferString &) const
void	home ()
void	ignoreWheelEvents (bool)
const char *	lastLink ()
void	recordScrollPos ()
void	reload ()
void	restoreScrollPos ()
void	setHtmlText (const char *)
void	setLinkBehavior (LinkBehavior)
void	setMaxLines (int)
void	setSource (const char *)
void	setText (const char *)
void	showToolTip (const char *)
const char *	source () const
Public Member Functions inherited from uiTextEditBase
	~uiTextEditBase ()
void	allowTextSelection (bool)
int	defaultHeight ()
int	defaultWidth ()
void	hideFrame ()
void	hideScrollBar (bool vertical)
bool	isModified () const
int	nrLines () const
void	readFromFile (const char *, int linecutlen=0)
bool	saveToFile (const char *, int linelen=0, bool newlns=true)
void	scrollToBottom ()
void	setDefaultHeight (int h)
void	setDefaultWidth (int w)
void	setEmpty ()
void	setLineWrapColumn (int nrcol)
void	setPlaceholderText (const uiString &)
const char *	text () const
bool	verticalSliderIsDown () const
	Returns false in absence of the slider. More...
Public Member Functions inherited from uiObject
	~uiObject ()
uiSize	actualSize (bool include_border=true) const
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)
virtual OD::Color	backgroundColor () const
virtual const ObjectSet< uiBaseObject > *	childList () const
void	close ()
void	deepRedraw ()
void	disabFocus ()
void	display (bool yn, bool shrink=false, bool maximized=false)
const uiFont *	font () const
QWidget *	getWidget () override
virtual bool	handleLongTabletPress ()
bool	hasFocus () const
virtual int	height () const
	Actual size in pixels. More...
bool	isCursorInside () const
bool	isDisplayed () const
virtual bool	isEmpty () const
bool	isSensitive () const
uiMainWin *	mainwin ()
uiParent *	parent ()
const uiParent *	parent () const
int	prefHNrPics () const
int	prefVNrPics () const
QWidget *	qwidget ()
const QWidget *	qwidget () const
void	reDraw (bool deep)
void	reParent (uiParent *)
OD::Color	roBackgroundColor () const
bool	sensitive () const
virtual void	setBackgroundColor (const OD::Color &)
virtual void	setBackgroundPixmap (const uiPixmap &)
void	setCaption (const uiString &)
virtual void	setCursor (const MouseCursor &)
void	setFocus ()
void	setFont (const uiFont &)
void	setHSzPol (SzPolicy)
void	setMaximumHeight (int)
void	setMaximumHeightInChar (int)
void	setMaximumWidth (int)
void	setMaximumWidthInChar (int)
void	setMinimumHeight (int)
void	setMinimumHeightInChar (int)
void	setMinimumWidth (int)
void	setMinimumWidthInChar (int)
virtual void	setName (const char *) override
virtual void	setPrefHeight (int)
void	setPrefHeightInChar (float)
void	setPrefHeightInChar (int)
virtual void	setPrefWidth (int)
void	setPrefWidthInChar (float)
void	setPrefWidthInChar (int)
void	setSensitive (bool yn=true)
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...
virtual void	setStyleSheet (const char *)
virtual void	setTextColor (const OD::Color &)
void	setToolTip (const uiString &)
void	setVSzPol (SzPolicy)
void	shallowRedraw ()
int	stretch (bool hor) const
SzPolicy	szPol (bool hor=true) const
const uiString &	toolTip () const
void	translateText () override
bool	visible () const
virtual int	width () const
	Actual size in pixels. More...
Public Member Functions inherited from uiBaseObject
	uiBaseObject (const char *nm, uiBody *=0)
virtual	~uiBaseObject ()
int	beginCmdRecEvent (const BufferString &msg)
int	beginCmdRecEvent (const char *msg=0)
int	beginCmdRecEvent (od_uint64 id, const char *msg=0)
uiBody *	body ()
const uiBody *	body () const
void	clear ()
void	endCmdRecEvent (int refnr, const char *msg=0)
void	endCmdRecEvent (od_uint64 id, int refnr, const char *msg=0)
void	finalise ()
bool	finalised () const
void	finalize ()
bool	finalized () const
const QWidget *	getWidget () const
virtual Notifier< uiBaseObject > &	postFinalise ()
virtual Notifier< uiBaseObject > &	postFinalize ()
virtual Notifier< uiBaseObject > &	preFinalise ()
virtual Notifier< uiBaseObject > &	preFinalize ()
Public Member Functions inherited from NamedCallBacker
	NamedCallBacker (const char *nm=0)
	NamedCallBacker (const NamedCallBacker &)
virtual Notifier< NamedCallBacker > &	objectToBeDeleted () const
bool	operator== (const NamedCallBacker &oth) const
bool	operator== (const NamedObject &oth) const
Public Member Functions inherited from CallBacker
	CallBacker ()
	CallBacker (const CallBacker &)
virtual	~CallBacker ()
bool	attachCB (const NotifierAccess &, const CallBack &, bool onlyifnew=false) const
bool	attachCB (const NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false) const
void	detachAllNotifiers () const
	Call from the destructor of your inherited object. More...
void	detachCB (const NotifierAccess &, const CallBack &) const
void	detachCB (const NotifierAccess *notif, const CallBack &cb) const
virtual bool	isCapsule () const
bool	isNotifierAttached (const NotifierAccess *) const
	Only for debugging purposes, don't use. More...
void	stopReceivingNotifications () const
virtual CallBacker *	trueCaller ()
Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=nullptr)
	NamedObject (const NamedObject &oth)
virtual	~NamedObject ()
virtual BufferString	getName () const
bool	getNameFromPar (const IOPar &)
const name_type &	name () const override
NamedObject &	operator= (const NamedObject &)
bool	operator== (const NamedObject &oth) const
Public Member Functions inherited from ObjectWithName
virtual	~ObjectWithName ()
bool	hasName (const char *nm) const
bool	hasName (const name_type &nm) const
void	putNameInPar (IOPar &) const

Public Attributes
Notifier< uiTextBrowser >	fileReOpened
Notifier< uiTextBrowser >	goneForwardOrBack
Notifier< uiTextBrowser >	linkClicked
Notifier< uiTextBrowser >	linkHighlighted
Public Attributes inherited from uiTextEditBase
CNotifier< uiTextEditBase, bool >	copyAvailable
Notifier< uiTextEditBase >	sliderPressed
Notifier< uiTextEditBase >	sliderReleased
Notifier< uiTextEditBase >	textChanged
Public Attributes inherited from uiObject
Notifier< uiObject >	closed
	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
void	copyAvailableCB (CallBacker *)
void	enableTailRead (bool yn)
int	maxLines () const override
QTextEdit &	qte () override
void	readTailCB (CallBacker *)
void	sliderPressedCB (CallBacker *)
void	sliderReleasedCB (CallBacker *)
Protected Member Functions inherited from uiTextEditBase
	uiTextEditBase (uiParent *, const char *, uiObjectBody &)
const QTextEdit &	qte () const
Protected Member Functions inherited from uiObject
	uiObject (uiParent *, const char *nm)
	uiObject (uiParent *, const char *nm, uiObjectBody &)
virtual bool	closeOK ()
	hook. Accepts/denies closing of window. More...
uiObjectBody *	objBody ()
const uiObjectBody *	objBody () const
void	triggerSetGeometry (const i_LayoutItem *, uiRect &)
	setGeometry should be triggered by this's layoutItem More...
void	updateToolTip (CallBacker *=nullptr)
Protected Member Functions inherited from uiBaseObject
void	setBody (uiBody *b)
Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const

Protected Attributes
bool	cangobackw_
bool	cangoforw_
bool	forceplaintxt_
BufferString	lastline_
od_int64	lastlinestartpos_
BufferString	lastlink_
bool	logviewmode_
int	maxlines_
BufferString	textsrc_
Timer *	timer_
Protected Attributes inherited from uiTextEditBase
int	defaultheight_
int	defaultwidth_
BufferString	result_
Protected Attributes inherited from uiObject
uiString	tooltip_
uiObjEventFilter *	uiobjeventfilter_
Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool >	delalreadytriggered_
Notifier< NamedCallBacker >	delnotif_
Protected Attributes inherited from NamedObject
BufferString	name_

Private Member Functions
uiTextBrowserBody &	mkbody (uiParent *, const char *, bool)

Private Attributes
uiTextBrowserBody *	body_

Friends
class	i_BrowserMessenger

Additional Inherited Members
Static Public Member Functions inherited from uiObject
static int	baseFldSize ()
static int	iconSize ()
static void	setTabOrder (uiObject *first, uiObject *second)
static void	updateToolTips ()
Static Public Member Functions inherited from uiBaseObject
static void	addCmdRecorder (const CallBack &)
static void	removeCmdRecorder (const CallBack &)
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()

Detailed Description

<>

Member Enumeration Documentation

LinkBehavior

enum uiTextBrowser::LinkBehavior

Enumerator
None
FollowLocal
FollowAll

Constructor & Destructor Documentation

uiTextBrowser()

uiTextBrowser::uiTextBrowser	(	uiParent *	,
		const char *	nm = "File browser",
		int	maxlns = mUdf(int),
		bool	forceplaintext = true,
		bool	logmode = false
	)

~uiTextBrowser()

uiTextBrowser::~uiTextBrowser

(

)

Member Function Documentation

backward()

void uiTextBrowser::backward

(

)

canGoBackward()

bool uiTextBrowser::canGoBackward ( )

inline

canGoForward()

bool uiTextBrowser::canGoForward ( )

inline

copyAvailableCB()

void uiTextBrowser::copyAvailableCB ( CallBacker *  )

protected

enableTailRead()

void uiTextBrowser::enableTailRead ( bool  yn )

protected

forward()

void uiTextBrowser::forward

(

)

getHtmlText()

void uiTextBrowser::getHtmlText

(

BufferString &

)

const

home()

void uiTextBrowser::home

(

)

ignoreWheelEvents()

void uiTextBrowser::ignoreWheelEvents

(

bool

)

lastLink()

const char* uiTextBrowser::lastLink ( )

inline

maxLines()

int uiTextBrowser::maxLines ( ) const

inlineoverrideprotectedvirtual

Reimplemented from uiTextEditBase.

mkbody()

uiTextBrowserBody& uiTextBrowser::mkbody ( uiParent *  , const char *  , bool    )

private

qte()

QTextEdit& uiTextBrowser::qte ( )

overrideprotectedvirtual

Implements uiTextEditBase.

readTailCB()

void uiTextBrowser::readTailCB ( CallBacker *  )

protected

recordScrollPos()

void uiTextBrowser::recordScrollPos

(

)

reload()

void uiTextBrowser::reload

(

)

restoreScrollPos()

void uiTextBrowser::restoreScrollPos

(

)

setHtmlText()

void uiTextBrowser::setHtmlText

(

const char *

)

setLinkBehavior()

void uiTextBrowser::setLinkBehavior

(

LinkBehavior

)

setMaxLines()

void uiTextBrowser::setMaxLines

(

int

)

setSource()

void uiTextBrowser::setSource

(

const char *

)

setText()

void uiTextBrowser::setText

(

const char *

)

showToolTip()

void uiTextBrowser::showToolTip

(

const char *

)

sliderPressedCB()

void uiTextBrowser::sliderPressedCB ( CallBacker *  )

protected

sliderReleasedCB()

void uiTextBrowser::sliderReleasedCB ( CallBacker *  )

protected

source()

const char* uiTextBrowser::source

(

)

const

Friends And Related Function Documentation

i_BrowserMessenger

friend class i_BrowserMessenger

friend

Member Data Documentation

body_

uiTextBrowserBody* uiTextBrowser::body_

private

cangobackw_

bool uiTextBrowser::cangobackw_

protected

cangoforw_

bool uiTextBrowser::cangoforw_

protected

fileReOpened

Notifier<uiTextBrowser> uiTextBrowser::fileReOpened

forceplaintxt_

bool uiTextBrowser::forceplaintxt_

protected

goneForwardOrBack

Notifier<uiTextBrowser> uiTextBrowser::goneForwardOrBack

lastline_

BufferString uiTextBrowser::lastline_

protected

lastlinestartpos_

od_int64 uiTextBrowser::lastlinestartpos_

protected

lastlink_

BufferString uiTextBrowser::lastlink_

protected

linkClicked

Notifier<uiTextBrowser> uiTextBrowser::linkClicked

linkHighlighted

Notifier<uiTextBrowser> uiTextBrowser::linkHighlighted

logviewmode_

bool uiTextBrowser::logviewmode_

protected

maxlines_

int uiTextBrowser::maxlines_

protected

textsrc_

BufferString uiTextBrowser::textsrc_

protected

timer_

Timer* uiTextBrowser::timer_

protected