1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-08-24 13:50:49 +03:00
Files
occt/src/Draw/Draw_ProgressIndicator.cdl
bugmaster b311480ed5 0023024: Update headers of OCCT files
Added appropriate copyright and license information in source files
2012-03-21 19:43:04 +04:00

94 lines
3.4 KiB
Plaintext
Executable File

-- Created on: 2008-06-25
-- Created by: data exchange team
-- Copyright (c) 2008-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.
class ProgressIndicator from Draw inherits ProgressIndicator from Message
---Purpose: Implements ProgressIndicator (interface provided by Message)
-- for DRAW, with possibility to output to TCL window
-- and/or trace file
uses
Interpretor from Draw
is
Create (di: Interpretor from Draw; updateTime: Integer = 0)
returns ProgressIndicator from Draw;
---Purpose: Creates a progress indicator and remembers pointer to
-- Draw_Interpretor
-- The updateTime, if given, defines time interval between
-- updates of the indicator (in seconds)
Destroy (me: mutable);
---C++: alias ~
---Purpose: Destructor; calls Reset()
SetTextMode(me : mutable; theTextMode : Boolean);
---Purpose: Sets text output mode (on/off)
GetTextMode(me) returns Boolean;
---Purpose: Gets text output mode (on/off)
SetGraphMode(me : mutable; theGraphMode : Boolean);
---Purpose: Sets graphical output mode (on/off)
GetGraphMode(me) returns Boolean;
---Purpose: Gets graphical output mode (on/off)
---Scope: Redefined methods
Reset (me: mutable) is redefined;
---Purpose: Clears/erases opened TCL windows if any
-- and sets myBreak to False
Show (me: mutable; force: Boolean = Standard_True)
returns Boolean is redefined;
---Purpose: Defines method Show of Progress Indicator
UserBreak (me: mutable) returns Boolean is redefined;
---Purpose: Redefines method UserBreak of Progress Indicator
---Scope: Class methods maintaining static data
DefaultTextMode (myclass) returns Boolean;
---C++: return &
DefaultGraphMode (myclass) returns Boolean;
---C++: return &
---Purpose: Get/Set default values for output modes
StopIndicator (myclass) returns Integer;
---C++: return &
---Purpose: Internal method for implementation of UserBreak mechanism
fields
myTextMode : Boolean; -- text output mode (on/off)
myGraphMode : Boolean; -- graphical output mode (on/off)
myDraw: Address; -- pointer to Draw_Interpretor (!!!)
myShown: Boolean; -- whether graphical window is shown
myBreak: Boolean; -- whether user break was signaled
myUpdateTime: Integer; -- Time interval for update (in sec)
myLastUpdate: Size; -- Start time (first call to Show())
myStartTime: Size; -- Start time (first call to Show())
end ProgressIndicator;