ReactOS  0.4.12-dev-945-g5a2911d
progress.h
Go to the documentation of this file.
1 /*
2  * ReactOS kernel
3  * Copyright (C) 2002 ReactOS Team
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19 /*
20  * COPYRIGHT: See COPYING in the top level directory
21  * PROJECT: ReactOS text-mode setup
22  * FILE: base/setup/usetup/progress.h
23  * PURPOSE: Partition list functions
24  * PROGRAMMER:
25  */
26 
27 #pragma once
28 
29 struct _PROGRESSBAR;
30 
31 typedef BOOLEAN
32 (NTAPI *PUPDATE_PROGRESS)(
33  IN struct _PROGRESSBAR* Bar,
35  OUT PSTR Buffer,
37 
38 typedef struct _PROGRESSBAR
39 {
40  /* Border and text positions */
47 
49 
50  /* Maximum and current step counts */
53 
54  /* User-specific displayed bar progress/position */
55  PUPDATE_PROGRESS UpdateProgressProc;
58 
59  /* Static progress bar cues */
65 
66 
67 /* FUNCTIONS ****************************************************************/
68 
71  IN SHORT Left,
72  IN SHORT Top,
73  IN SHORT Right,
74  IN SHORT Bottom,
75  IN SHORT TextTop,
76  IN SHORT TextRight,
77  IN BOOLEAN DoubleEdge,
78  IN SHORT ProgressColour,
79  IN ULONG StepCount,
80  IN PCSTR DescriptionText OPTIONAL,
81  IN PCSTR ProgressFormatText OPTIONAL,
82  IN PUPDATE_PROGRESS UpdateProgressProc OPTIONAL);
83 
86  IN SHORT Left,
87  IN SHORT Top,
88  IN SHORT Right,
89  IN SHORT Bottom,
90  IN SHORT TextTop,
91  IN SHORT TextRight,
92  IN BOOLEAN DoubleEdge,
93  IN PCSTR DescriptionText OPTIONAL);
94 
95 VOID
97  IN OUT PPROGRESSBAR Bar);
98 
99 VOID
101  IN PPROGRESSBAR Bar,
102  IN ULONG StepCount);
103 
104 VOID
106  IN PPROGRESSBAR Bar);
107 
108 VOID
110  IN PPROGRESSBAR Bar,
111  IN ULONG Step);
112 
113 /* EOF */
BOOLEAN DoubleEdge
Definition: progress.h:60
#define IN
Definition: typedefs.h:38
IN BOOLEAN OUT PSTR IN SIZE_T cchBufferSize
Definition: progress.h:34
VOID DestroyProgressBar(IN OUT PPROGRESSBAR Bar)
Definition: progress.c:339
SHORT TextRight
Definition: progress.h:46
SHORT Left
Definition: progress.h:41
PPROGRESSBAR CreateProgressBar(IN SHORT Left, IN SHORT Top, IN SHORT Right, IN SHORT Bottom, IN SHORT TextTop, IN SHORT TextRight, IN BOOLEAN DoubleEdge, IN PCSTR DescriptionText OPTIONAL)
Definition: progress.c:317
PUPDATE_PROGRESS UpdateProgressProc
Definition: progress.h:55
ULONG CurrentStep
Definition: progress.h:52
VOID ProgressNextStep(IN PPROGRESSBAR Bar)
Definition: progress.c:361
SHORT Pos
Definition: progress.h:57
NTSTATUS(* NTAPI)(IN PFILE_FULL_EA_INFORMATION EaBuffer, IN ULONG EaLength, OUT PULONG ErrorOffset)
Definition: IoEaTest.cpp:117
ULONG StepCount
Definition: progress.h:51
SHORT ProgressColour
Definition: progress.h:61
short SHORT
Definition: pedump.c:59
SHORT Bottom
Definition: progress.h:44
unsigned char BOOLEAN
SHORT Right
Definition: progress.h:43
VOID ProgressSetStep(IN PPROGRESSBAR Bar, IN ULONG Step)
Definition: progress.c:368
ULONG Progress
Definition: progress.h:56
SHORT TextTop
Definition: progress.h:45
SHORT Width
Definition: progress.h:48
PPROGRESSBAR CreateProgressBarEx(IN SHORT Left, IN SHORT Top, IN SHORT Right, IN SHORT Bottom, IN SHORT TextTop, IN SHORT TextRight, IN BOOLEAN DoubleEdge, IN SHORT ProgressColour, IN ULONG StepCount, IN PCSTR DescriptionText OPTIONAL, IN PCSTR ProgressFormatText OPTIONAL, IN PUPDATE_PROGRESS UpdateProgressProc OPTIONAL)
Definition: progress.c:272
PCSTR DescriptionText
Definition: progress.h:62
typedef BOOLEAN(NTAPI *PUPDATE_PROGRESS)(IN struct _PROGRESSBAR *Bar
struct _PROGRESSBAR PROGRESSBAR
ULONG_PTR SIZE_T
Definition: typedefs.h:78
static LPHIST_ENTRY Bottom
Definition: history.c:54
signed char * PSTR
Definition: retypes.h:7
struct _PROGRESSBAR * PPROGRESSBAR
SHORT Top
Definition: progress.h:42
#define OUT
Definition: typedefs.h:39
unsigned int ULONG
Definition: retypes.h:1
VOID ProgressSetStepCount(IN PPROGRESSBAR Bar, IN ULONG StepCount)
Definition: progress.c:347
const char * PCSTR
Definition: typedefs.h:51
IN BOOLEAN AlwaysUpdate
Definition: progress.h:34
IN BOOLEAN OUT PSTR Buffer
Definition: progress.h:34
static LPHIST_ENTRY Top
Definition: history.c:53
PCSTR ProgressFormatText
Definition: progress.h:63
PULONG MinorVersion OPTIONAL
Definition: CrossNt.h:68