UT_Interrupt Class Reference

#include <UT_Interrupt.h>

Inheritance diagram for UT_Interrupt:

List of all members.

Public Member Functions
	UT_Interrupt (const char *app_title=0)
virtual	~UT_Interrupt ()
void	setEnabled (int state, int print_longtext=0)
bool	isEnabled () const
void	setUseLocks (int state)
bool	setInterruptable (bool allow, bool *prev_enabled=NULL, bool allow_ui=false)
bool	getInterruptable () const
UT_Lock &	getInterruptableLock ()
bool	getAllowUI () const
int	opStart (const char *opname=0, int npoll=0, int immediate_dialog=0, int *opid=0)
int	opInterrupt (int percent=-1)
void	opEnd (int opid=-1)
void	setLongOpText (const char *longoptext)
void	setLongPercent (float percent)
void	setAppTitle (const char *title)
const char *	getAppTitle () const
void	setActiveCallback (UT_InterruptCB function)
void	setInterruptHandler (UT_InterruptHandler *hand)
UT_InterruptHandler *	getInterruptHandler ()
void	pushInterruptCallback (void(*callback)())
void	popInterruptCallback ()
void	interrupt (int use_semaphore=0)
void	pause (bool dopause)
bool	isPaused () const
void	setSignalCallback (UTsigHandler function)
bool	testMemoryThreshold ()
Static Public Member Functions
static void	setUpdateModeCallback (OPUI_UpdateModeCB function)
static void	setEscapeCheckCallback (UI_CheckForEscapeCB function)
static bool	getIsEscapeCheckCallbackSet ()
Protected Member Functions
const char *	getSharedKey () const
virtual int	detach ()

---

Detailed Description

Examples:

CHOP/CHOP_Blend.C, CHOP/CHOP_Spring.C, CHOP/CHOP_Spring.h, POP/POP_LocalForce.C, ROP/ROP_Dumper.C, ROP/ROP_Dumper.h, SIM/SIM_GasAdd.C, and SOP/SOP_Star.C.

Definition at line 79 of file UT_Interrupt.h.

---

Constructor & Destructor Documentation

UT_Interrupt::UT_Interrupt

(

const char *

app_title = 0

)

[explicit]

virtual UT_Interrupt::~UT_Interrupt

(

)

[virtual]

---

Member Function Documentation

virtual int UT_Interrupt::detach

(

)

[protected, virtual]

Reimplemented from UT_SharedMem.

bool UT_Interrupt::getAllowUI

(

)

const [inline]

Definition at line 110 of file UT_Interrupt.h.

const char* UT_Interrupt::getAppTitle

(

)

const [inline]

Definition at line 154 of file UT_Interrupt.h.

bool UT_Interrupt::getInterruptable

(

)

const [inline]

Definition at line 108 of file UT_Interrupt.h.

UT_Lock& UT_Interrupt::getInterruptableLock

(

)

[inline]

Definition at line 109 of file UT_Interrupt.h.

UT_InterruptHandler* UT_Interrupt::getInterruptHandler

(

)

[inline]

Definition at line 169 of file UT_Interrupt.h.

static bool UT_Interrupt::getIsEscapeCheckCallbackSet

(

)

[inline, static]

Definition at line 180 of file UT_Interrupt.h.

const char* UT_Interrupt::getSharedKey

(

)

const [protected]

void UT_Interrupt::interrupt

(

int

use_semaphore = 0

)

bool UT_Interrupt::isEnabled

(

)

const [inline]

Definition at line 91 of file UT_Interrupt.h.

bool UT_Interrupt::isPaused

(

)

const

void UT_Interrupt::opEnd

(

int

opid = -1

)

Examples:

CHOP/CHOP_Blend.C, CHOP/CHOP_Spring.C, and SOP/SOP_Star.C.

int UT_Interrupt::opInterrupt

(

int

percent = -1

)

Examples:

CHOP/CHOP_Blend.C, CHOP/CHOP_Spring.C, POP/POP_LocalForce.C, SIM/SIM_GasAdd.C, and SOP/SOP_Star.C.

int UT_Interrupt::opStart	(	const char *	opname = 0,
		int	npoll = 0,
		int	immediate_dialog = 0,
		int *	opid = 0
	)

Examples:

CHOP/CHOP_Blend.C, CHOP/CHOP_Spring.C, and SOP/SOP_Star.C.

void UT_Interrupt::pause

(

bool

dopause

)

void UT_Interrupt::popInterruptCallback

(

)

void UT_Interrupt::pushInterruptCallback

(

void(*)()

callback

)

void UT_Interrupt::setActiveCallback

(

UT_InterruptCB

function

)

[inline]

Definition at line 160 of file UT_Interrupt.h.

void UT_Interrupt::setAppTitle

(

const char *

title

)

void UT_Interrupt::setEnabled	(	int	state,
		int	print_longtext = 0
	)

static void UT_Interrupt::setEscapeCheckCallback

(

UI_CheckForEscapeCB

function

)

[inline, static]

Definition at line 178 of file UT_Interrupt.h.

bool UT_Interrupt::setInterruptable	(	bool	allow,
		bool *	prev_enabled = NULL,
		bool	allow_ui = false
	)

void UT_Interrupt::setInterruptHandler

(

UT_InterruptHandler *

hand

)

[inline]

Definition at line 163 of file UT_Interrupt.h.

void UT_Interrupt::setLongOpText

(

const char *

longoptext

)

void UT_Interrupt::setLongPercent

(

float

percent

)

void UT_Interrupt::setSignalCallback

(

UTsigHandler

function

)

static void UT_Interrupt::setUpdateModeCallback

(

OPUI_UpdateModeCB

function

)

[inline, static]

Definition at line 173 of file UT_Interrupt.h.

void UT_Interrupt::setUseLocks

(

int

state

)

[inline]

Definition at line 95 of file UT_Interrupt.h.

bool UT_Interrupt::testMemoryThreshold

(

)

[inline]

Definition at line 207 of file UT_Interrupt.h.

---

The documentation for this class was generated from the following file:

• UT/UT_Interrupt.h