|
Rebar control help
Function help:
Real API_Rebar_Create (Real Parent Handle,Real Style Flags, Real Extended Style Flags);
This function creates a new rebar control.
Argument list:
(0) Parent Handle: Identifies the window handle of the window to create this control on.
(1) Style Flags: The style flags, supports the Global Control Styles, the Common Control Styles and the following styles:
RBS_AUTOSIZE
The rebar control will automatically change the layout of the bands when the size or position of the control changes.
RBS_BANDBORDERS
The rebar control displays narrow lines to separate adjacent bands.
RBS_DBLCLKTOGGLE
The rebar band will toggle its maximized or minimized state when the user double-clicks the band. Without this style, the maximized or minimized state is toggled when the user single-clicks on the band.
RBS_FIXEDORDER
The rebar control always displays bands in the same order. You can move bands to different rows, but the band order is static.
RBS_VARHEIGHT
The rebar control displays bands at the minimum required height, when possible. Without this style, the rebar control displays all bands at the same height, using the height of the tallest visible band to determine the height of other bands.
RBS_VERTICALGRIPPER
The size grip will be displayed vertically instead of horizontally in a vertical rebar control. This style is ignored for rebar controls that do not have the CCS_VERT style.
Style flags can be separated by a bitwise or '|' operator.
(2) Extended Style Flags: This can be any combination of the Global Extended Control Styles.
Return value:
If this function succeeds, it returns the Control ID of the control, otherwise it returns 0.
Real API_Rebar_InsertBand ( Real Control ID, Real Zero Based Band Index, Real Style flags)
Argument list:
(0): Control ID: The Control ID, returned by API_Rebar_Create.
(1): The zero based index of the band. (0 = the first band)
(2): Style flags, use the following flags:
RBBS_BREAK
The band is on a new line.
RBBS_CHILDEDGE
The band has an edge at the top and bottom of the child window.
RBBS_FIXEDSIZE
The band can't be sized. With this style, the sizing grip is not displayed on the band.
RBBS_GRIPPERALWAYS
The band will always have a sizing grip, even if it is the only band in the rebar.
RBBS_HIDDEN
The band will not be visible.
RBBS_NOGRIPPER
The band will never have a sizing grip, even if there is more than one band in the rebar.
RBBS_VARIABLEHEIGHT
The band can be resized by the rebar control.
RBBS_NOVERT
Don't show when vertical.
RBBS_USECHEVRON
Display drop-down button.
RBBS_HIDETITLE
Keep band title hidden.
RBBS_TOPALIGN
Keep band in top row.
This function returns the current position of the progress bar.
Return value:
If this function succeeds, it returns true (1), otherwise it returns false (0).
Real API_Rebar_SetBandChild ( Real Control ID, Real Zero Based Band Index, Real Child Window Handle)
This function assigns a child to a rebar band.
Use API_Control_GetHandle to get the window handle from a control id.
Return value:
If this function succeeds, it returns true (1), otherwise it returns false (0).
Real API_Rebar_GetBandChild ( Real Control ID, Real Zero Based Band Index)
This function returns the window handle assigned to a rebar band.
Return value:
Returns the window handle.
Real API_Rebar_SetBandText ( Real Control ID,Real Zero Based Band Index, String Text)
This function changes the text inside a rebar band.
Return value:
If this function succeeds, it returns true (1), otherwise it returns false (0).
String API_Rebar_GetBandText ( Real Control ID,Real Zero Based Band Index)
This function returns the text inside a rebar band.
Return value:
Returns the text.
Real API_Rebar_SetBandSize ( Real Control ID,Real Zero Based Band Index, Real Size)
This function changes the size ( the width in pixels) of a rebar band.
Return value:
If this function succeeds, it returns true (1), otherwise it returns false (0).
Real API_Rebar_GetBandSize ( Real Control ID,Real Zero Based Band Index)
This function returns the size ( the width in pixels) of a rebar band.
Return value:
Returns the size.
Real API_Rebar_SetBandSizes ( Real Control ID,Real Zero Based Band Index, Real Minimum Child Width, Real Minimum Child Height, Real Initial Height, Real Maximum Height)
This function changes some size attributes of a rebar band.
Return value:
If this function succeeds, it returns true (1), otherwise it returns false (0).
Real API_Rebar_SetBandStyle ( Real Control ID,Real Zero Based Band Index, Real Style Flags)
This function sets the new style flags (argument2 of API_Rebar_InsertBand) of a rebar band.
Return value:
If this function succeeds, it returns true (1), otherwise it returns false (0).
Real API_Rebar_GetBandStyle ( Real Control ID,Real Zero Based Band Index)
This function returns the new style flags (argument2 of API_Rebar_InsertBand) of a rebar band.
Return value:
Returns the style flags.
Real API_Rebar_DeleteBand ( Real Control ID,Real Zero Based Band Index)
This function removes a rebar band from the rebar.
Return value:
If this function succeeds, it returns true (1), otherwise it returns false (0).
Real API_Rebar_MoveBand ( Real Control ID,Real Old Zero Based Band Index, New Zero Based Band Index)
This function moves a rebar band to a specified index.
Return value:
If this function succeeds, it returns true (1), otherwise it returns false (0).
Real API_Rebar_GetBandCount ( Real Control ID)
This function returns the number of bands inside a rebar.
Return value:
Returns the count of bands.
Real API_Rebar_GetBarHeight ( Real Control ID)
This function returns the height of a rebar.
Return value:
Returns the height in pixels.
Example code:
Rebar1 = API_Rebar_Create (Win2,0,WS_EX_TOOLWINDOW);
API_Rebar_InsertBand (Rebar1,0,0);
API_Rebar_InsertBand (Rebar1,1,0);
API_Rebar_SetBandText (Rebar1,0,"Band 0");
API_Rebar_SetBandText (Rebar1,1,"Band 1");
API_Rebar_SetBandChild (Rebar1,0,API_Control_GetHandle (Progress1));
API_Rebar_SetBandSizes (Rebar1,0,100,10,10,30);
|
is
Return to help index
|
|