The SalQuickTabs type exposes the following members.
Methods
Name | Description | |
---|---|---|
Add |
Append a tab. Redraw is optional
Return an index
| |
AddPage |
Add a page.
Call this function to add a page to the page list.
The page window will not be created until the page is activated.
The return value is TRUE or FALSE.
| |
ApplyFormPageChanges |
Apply changes to all pages.
Call this function to cause the PAGEM_ApplyChanges message to be sent to all form pages.
Typically this function is called when the "OK" or "Apply Changes" button is selected.
The return value is TRUE or FALSE.
| |
BringToTop |
Activate a tab
| |
BringWindowToTop |
Brings a window to the top of all overlapping windows.
(Inherited from SalUserControl.) | |
CancelMode |
Cancel a user action. This can
be called when processing a TABSM_ message.
| |
CenterWindow |
Centers a window. If the window is a top-level window, it centers it on the
desktop. If the window is a child window, it centers it on top of its parent.
(Inherited from SalUserControl.) | |
Clear |
Clear all tabs from the frame.
Redraw is optional.
| |
ClearCursor |
Clears a window's cursor.
(Inherited from SalUserControl.) | |
ClearPages |
Clear all pages.
Call this function to remove all entries from the page list and destroy any existing windows.
The return value is TRUE of FALSE.
| |
CreatePage |
Create a page window.
This function to causes the page window to be created.
Typically it is not necessary to call this function because SetCurrentPage
will take care of creating the page window.
The page window will not be shown until SetCurrentPage is called.
| |
Delete |
Delete a tab at a location. Redraw is optional.
Return TRUE or FALSE.
| |
DestroyPage |
Destroy a page window.
Call this function to destroy a page window.
The page is not removed from the list. The page window can be recreated..
The return value is TRUE or FALSE.
| |
DestroyWindow |
Destroys a form window, a top-level table window, or a modeless dialog box created
with SalCreateWindow.
(Inherited from SalUserControl.) | |
DisableWindow |
Disables keyboard and mouse input to a window. If the window contains text (for example,
a push button), the text is grayed. If the window is a data field, it cannot
receive the focus.
(Inherited from SalUserControl.) | |
Dispose | (Overrides ContainerControl..::..Dispose(Boolean).) | |
Enable |
Enable or disable a tab
| |
EnableWindow |
Enables keyboard and mouse input to a window.
(Inherited from SalUserControl.) | |
FindChild |
This function finds a child window of a given name in the specified window.
(Inherited from SalUserControl.) | |
FindLabel |
Find a tab give a tab label
| |
FindName |
Find a tab give a tab name
| |
FindTabFrame |
Finds the tab frame window on a form or dialog box
| |
FormUnitsToPixels |
Computes the number of pixels in the number of form units. Form units
are a unit of measurement used by functions which move and position
objects. Form units are computed using physical units (pixels) in conjunction
with the window's font size.
(Inherited from SalUserControl.) | |
FromHandle |
Returns the control associated with the handle.
| |
GetClassName |
Return the name of a window's class as a string.
(Inherited from SalUserControl.) | |
GetClicked |
Get the index of the tab being clicked.
This should only be called during a
click notification.
| |
GetContentsBorderRect |
Get the area between the contents rect and the edge of the tab frame. For
example nLeft will indicate the width of the left border, nTop will indicate the
combined height of the top border and tab area.
| |
GetContentsRect |
Get the area available for child controls. Coordinates
are relative to the parent window.
| |
GetContentsRectPixels |
Get the area available for child controls. Coordinates
are relative to the parent window.
| |
GetControlTabPages |
Returns the names of the tab pages that the control is
associated to. The list if names is separated by a semicolon.
| |
GetControlType |
Returns an object's type.
(Inherited from SalUserControl.) | |
GetCount |
Get the count of tabs
| |
GetFirstChild |
Returns the handle of the first child window of the specified type. You can use this
function to get the handles of MDI child windows.
(Inherited from SalUserControl.) | |
GetFont |
Gets a window's font name, size, and enhancements.
(Inherited from SalUserControl.) | |
GetLabel |
Get the label displayed on a tab
| |
GetLocation |
Returns a window's current position on the X and Y axes.
(Inherited from SalUserControl.) | |
GetMarginRect |
Get the margins defined for a tiled-to-parent tabbed frame
| |
GetName()()()() |
Gets the name of an object.
(Inherited from SalUserControl.) | |
GetName(SalString%) |
Gets the name of an object.
(Inherited from SalUserControl.) | |
GetName(SalNumber, SalString%) |
Get the name associated with a tab
| |
GetNextChild |
Returns the handle of the next child window that matches a specified type.
(Inherited from SalUserControl.) | |
GetPageWindow |
Get the window of a page.
Call this function to get the Window Handle of a page.
The return value is the Window Handle of the page. hWndNULL is returned if the page window has not been created.
| |
GetParent |
Returns the handle of an object's parent window.
(Inherited from SalUserControl.) | |
GetProperty(SalString) |
Gets the value of a named property.
(Inherited from SalUserControl.) | |
GetProperty(SalString, SalString%) |
Gets the value of a named property.
(Inherited from SalUserControl.) | |
GetRowCount |
Retrieve the number rows of tabs
| |
GetSize |
Returns a window's size.
(Inherited from SalUserControl.) | |
GetText(SalNumber) |
Retrieves the text of a window.
(Inherited from SalUserControl.) | |
GetText(SalString%, SalNumber) |
Retrieves the text of a window.
(Inherited from SalUserControl.) | |
GetTop |
Get the index of the active tab
| |
GetWindowColor |
Gets a window's color.
(Inherited from SalUserControl.) | |
GetWindowState |
Returns a window's current state.
(Inherited from SalUserControl.) | |
HideWindow()()()() |
Hides a window.
(Inherited from SalUserControl.) | |
HideWindow(SalWindowHandle) |
Use this function instead of SalHideWindow. This function will keep the window
hidden as tabs are selected. Use the class function ShowWindow to undo the affect
of this function.
| |
HideWindowAndLabel |
Use this function instead of SalHideWindowAndLabel. This function will keep the window
hidden as tabs are selected. Use the class function ShowWindowWindowAndLabel to
undo the affect of this function.
| |
IndexFromPoint |
Get the tab, if any, under a given point (in pixels). A negative number is returned if the point
is not over a tab.
| |
Insert |
Insert a tab at a location. Redraw is optional.
Return TRUE or FALSE.
| |
InvalidateWindow |
Causes a window to be repainted.
(Inherited from SalUserControl.) | |
IsAssociatedWithTab |
Indicate wether a child window is associated with a tab
| |
IsDerivedFromClass |
Determines whether a window is an instance of the specified class.
(Inherited from SalUserControl.) | |
IsEnabled()()()() |
Determines whether a window is enabled for mouse and keyboard input.
(Inherited from SalUserControl.) | |
IsEnabled(SalNumber) |
Indicate whether a tab is enabled
| |
IsWindowVisible |
Returns if the specified control is considered to be visible
by the tab control and will be shown when the associated tab is selected.
| |
IsVisible |
Determines whether a window is currently visible.
(Inherited from SalUserControl.) | |
KillTimer |
Destroys an object's system timer.
(Inherited from SalUserControl.) | |
MoveWindow |
Moves a window a given number of form units on the X and Y axes relative to its current
position.
(Inherited from SalUserControl.) | |
Next |
Activate the next tab
| |
OnFontChanged | (Overrides ContainerControl..::..OnFontChanged(EventArgs).) | |
OnForeColorChanged | (Overrides Control..::..OnForeColorChanged(EventArgs).) | |
OnHandleCreated | (Overrides Control..::..OnHandleCreated(EventArgs).) | |
OnLayout | (Overrides ContainerControl..::..OnLayout(LayoutEventArgs).) | |
OnLoad | (Overrides UserControl..::..OnLoad(EventArgs).) | |
OnPaintBackground |
Fires the internal PaintBackground event.
This allows the handler component to take over the background painting
of the form. This is primarily used to allow the SalQuickTabs control
to paint transparent backgrounds.
(Inherited from SalUserControl.) | |
OnParentChanged | (Overrides ContainerControl..::..OnParentChanged(EventArgs).) | |
PaintBackground |
Delegates the painting of the background to the tab control when the
rectangle to paint is within the display area of the tab pages.
This is needed to render the background of transparent controls
using the visual style back color or the same back color of the tab page.
| |
PixelsToFormUnits |
Computes the number of form units based on the number of pixels.
Form units are a unit of measurement used by functions that move and position objects.
Form units are computed using physical units (pixels) in conjunction
with a window's font sizes.
(Inherited from SalUserControl.) | |
PostMessage |
Posts the specified message to a window by adding nMsg to hWndReceiver's message
queue.
(Inherited from SalUserControl.) | |
Prev |
Activate the previous tab
| |
ProcessKeys |
Handles keys to change the selected tab.
| |
Redraw |
Arranges tabs on the frame and repaints.
Call after adding tabs or clearing with a FALSE
redraw flag.
| |
ReloadTabs |
Reloads the original tabs configuration.
| |
ResizePages()()()() |
Resize all pages.
Call this function to resize all form pages.
The active page is resized first.
The return value is TRUE or FALSE.
| |
ResizePages(Rectangle) |
Resize all pages.
Call this function to resize all form pages.
The active page is resized first.
The return value is TRUE or FALSE.
| |
SendMessage |
Sends the specified message to a window. SalSendMsg does not return until the processing
for the message is complete.
(Inherited from SalUserControl.) | |
SendMessageToChildren |
Sends a message to all child items of a form window, dialog box, table window, or
MDI window.
(Inherited from SalUserControl.) | |
SendMsgToAssociated |
Send a message to all child windows associated with a tab
| |
SetContextMenu(Type, SalNumber) |
Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
(Inherited from SalUserControl.) | |
SetContextMenu(SalString, SalNumber) |
Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
(Inherited from SalUserControl.) | |
SetControlTabPages |
Sets the tab pages associated to child control.
The list is separated by a semicolon.
| |
SetCurrentPage |
Activates a page.
Causes the form page associated to the specified tab to be created and/or shown.
The current form page will be hidden.
| |
SetCursor(Int32, SalNumber) |
Sets a window's cursor.
(Inherited from SalUserControl.) | |
SetCursor(SalResourceCursor, SalNumber) |
Sets a window's cursor.
(Inherited from SalUserControl.) | |
SetCursor(SalString, SalNumber) |
Sets a window's cursor from a string variable.
(Inherited from SalUserControl.) | |
SetCursorFile |
Sets an application-defined cursor for the specified window. Use this function to
set the cursor from an image stored in a file.
(Inherited from SalUserControl.) | |
SetFocus |
Sets the focus to a specified window.
(Inherited from SalUserControl.) | |
SetFont |
Sets a window's font, font size, and font enhancements.
(Inherited from SalUserControl.) | |
SetLabel |
Set the label displayed on a tab.
Redraw is optional.
| |
SetLocation |
Moves a window to a new position (x, y) on the X and Y axes.
(Inherited from SalUserControl.) | |
SetMarginRect | ||
SetName |
Associate a name with a tab
| |
SetPageSize(Rectangle, SalBoolean) |
Defines the location and size of form pages.
| |
SetPageSize(SalNumber, SalNumber, SalNumber, SalNumber, SalBoolean) |
Defines the location and size of form pages.
| |
SetProperty |
Sets the value of a named property.
(Inherited from SalUserControl.) | |
SetSize |
Resizes a window.
(Inherited from SalUserControl.) | |
SetText |
Sets the text of a window.
(Inherited from SalUserControl.) | |
SetTimer |
Creates a system timer for a given object. When a timer event occurs, sends
SAM_Timer messages to the object in specified intervals. Timers are a limited
global resource. Your application must check the value returned by SalTimerSet
to verify that the timer was created.
(Inherited from SalUserControl.) | |
SetWindowColor |
Sets a window's color.
(Inherited from SalUserControl.) | |
SetWorkspaceBoundary |
Define the boundaries of the workspace so that a tiled-to-parent tab
frame won't be resized smaller than this boundary.
| |
ShowSiblings |
Show or hide child windows based on the current tab
| |
ShowWindow()()()() |
Makes a window visible.
(Inherited from SalUserControl.) | |
ShowWindow(SalWindowHandle) |
Use this function instead of SalShowWindow because it works properly
with the class function HideWindow
| |
ShowWindowAndLabel |
Use this function instead of SalShowWindowAndLabel because it works properly
with the class function HideWindowAndLabel.
| |
TrackPopupMenu(Type, SalNumber, SalNumber, SalNumber) |
Creates pop-up menus at runtime.
(Inherited from SalUserControl.) | |
TrackPopupMenu(SalString, SalNumber, SalNumber, SalNumber) |
Creates pop-up menus at runtime.
(Inherited from SalUserControl.) | |
UpdateWindow |
Forces the update of a window.
(Inherited from SalUserControl.) | |
WinHelp |
Starts the Windows help system.
(Inherited from SalUserControl.) | |
WndProc |
Process WM_DESTROY to clear the pages collection
to avoid destroying the form pages more than once.
(Overrides SalUserControl..::..WndProc(Message%).) | |
Yield |
Processes messages for this control.
(Inherited from SalUserControl.) |