ARB
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
ArbProgress::nestable Class Referenceabstract

#include <arb_progress.h>

Inheritance diagram for ArbProgress::nestable:
Inheritance graph
[legend]
Collaboration diagram for ArbProgress::nestable:
Collaboration graph
[legend]

Public Member Functions

virtual ~nestable ()
 
bool aborted () const
 
virtual void set_text (int level, const char *text)=0
 
virtual void update_gauge (double gauge)=0
 
virtual void dump () const
 
void child_sets_text (int level, const char *text)
 
void allow_title_reuse ()
 
void update_parent_gauge (double gauge)
 
void child_terminated ()
 
void initial_update ()
 
void force_update ()
 
void inc ()
 
void inc_by (SINT count)
 
void inc_to (SINT x)
 
void inc_to_avoid_overflow (SINT x)
 
void done ()
 
void auto_subtitles (const char *prefix)
 
bool owns (const counter *pwnd) const
 
bool is_correct_owner () const
 

Static Public Member Functions

static SmartPtr< nestablecreate (const char *title, SINT overall_count)
 
static SmartPtr< nestablecreate_suppressor ()
 
static void show_comment (const char *comment)
 

Protected Member Functions

virtual SmartPtr< nestablecreate_child_progress (const char *title, SINT overall_count)=0
 
 nestable (counter *counter_, bool has_title_)
 

Protected Attributes

charname
 
bool has_title
 
countercntr
 

Static Protected Attributes

static nestablerecent = NULp
 
static arb_status_implementationimpl = NULp
 

Detailed Description

Definition at line 79 of file arb_progress.h.

Constructor & Destructor Documentation

ArbProgress::nestable::nestable ( counter counter_,
bool  has_title_ 
)
inlineprotected

Definition at line 99 of file arb_progress.h.

References arb_assert, is_correct_owner(), NULp, and recent.

virtual ArbProgress::nestable::~nestable ( )
inlinevirtual

Definition at line 121 of file arb_progress.h.

References arb_assert, and cntr.

Member Function Documentation

virtual SmartPtr<nestable> ArbProgress::nestable::create_child_progress ( const char title,
SINT  overall_count 
)
protectedpure virtual

Referenced by create().

SmartPtr< nestable > nestable::create ( const char title,
SINT  overall_count 
)
static
SmartPtr< nestable > nestable::create_suppressor ( )
static

Definition at line 346 of file arb_progress.cxx.

bool nestable::aborted ( ) const

Definition at line 350 of file arb_progress.cxx.

References impl, and arb_status_implementation::user_abort.

Referenced by arb_progress::aborted().

virtual void ArbProgress::nestable::set_text ( int  level,
const char text 
)
pure virtual
virtual void ArbProgress::nestable::update_gauge ( double  gauge)
pure virtual

Implemented in null_progress, and initial_progress.

virtual void ArbProgress::nestable::dump ( ) const
virtual
void ArbProgress::nestable::child_sets_text ( int  level,
const char text 
)
inline

Definition at line 141 of file arb_progress.h.

References ArbProgress::counter::has_auto_subtitles(), and set_text().

void ArbProgress::nestable::allow_title_reuse ( )
inline

Definition at line 144 of file arb_progress.h.

Referenced by arb_progress::allow_title_reuse().

void ArbProgress::nestable::update_parent_gauge ( double  gauge)
inline

Definition at line 146 of file arb_progress.h.

References ArbProgress::counter::child_updates_gauge().

void ArbProgress::nestable::child_terminated ( )
inline

Definition at line 147 of file arb_progress.h.

References ArbProgress::counter::implicit_inc().

Referenced by arb_progress::sub_progress_skipped().

void ArbProgress::nestable::initial_update ( )
inline

Definition at line 149 of file arb_progress.h.

References ArbProgress::counter::force_update().

void ArbProgress::nestable::force_update ( )
inline

Definition at line 150 of file arb_progress.h.

References ArbProgress::counter::force_update().

Referenced by arb_progress::force_update().

void ArbProgress::nestable::inc ( )
inline

Definition at line 152 of file arb_progress.h.

References ArbProgress::counter::inc().

Referenced by arb_progress::inc().

void ArbProgress::nestable::inc_by ( SINT  count)
inline

Definition at line 153 of file arb_progress.h.

References arb_assert, and ArbProgress::counter::inc_by().

Referenced by arb_progress::inc_by().

void ArbProgress::nestable::inc_to ( SINT  x)
inline

Definition at line 154 of file arb_progress.h.

References ArbProgress::counter::inc_to().

Referenced by arb_progress::inc_to().

void ArbProgress::nestable::inc_to_avoid_overflow ( SINT  x)
inline
void ArbProgress::nestable::done ( )
inline

Definition at line 156 of file arb_progress.h.

References ArbProgress::counter::done().

Referenced by arb_progress::done().

void ArbProgress::nestable::auto_subtitles ( const char prefix)
inline

Definition at line 157 of file arb_progress.h.

References ArbProgress::counter::auto_subtitles().

Referenced by arb_progress::auto_subtitles().

static void ArbProgress::nestable::show_comment ( const char comment)
inlinestatic

Definition at line 159 of file arb_progress.h.

References ArbProgress::LEVEL_SUBTITLE, and set_text().

Referenced by arb_progress::show_comment().

bool ArbProgress::nestable::owns ( const counter pwnd) const
inline
bool ArbProgress::nestable::is_correct_owner ( ) const
inline

Definition at line 164 of file arb_progress.h.

References ArbProgress::counter::owned_by(), and owns().

Referenced by nestable().

Member Data Documentation

char* ArbProgress::nestable::name
protected

Definition at line 85 of file arb_progress.h.

bool ArbProgress::nestable::has_title
protected

Definition at line 91 of file arb_progress.h.

counter* ArbProgress::nestable::cntr
protected

Definition at line 92 of file arb_progress.h.

Referenced by ~nestable().

nestable * nestable::recent = NULp
staticprotected

Definition at line 94 of file arb_progress.h.

Referenced by create(), and nestable().

arb_status_implementation * nestable::impl = NULp
staticprotected

Definition at line 95 of file arb_progress.h.

Referenced by aborted(), and create().


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