ultimatepp/uppsrc/CtrlLib/src.tpp/HeaderCtrl_en-us.tpp

topic "HeaderCtrl";
[i448;a25;kKO9;*@(64)2 $$1,0#37138531426314131252341829483380:class]
[l288;2 $$2,0#27521748481378242620020725143825:desc]
[a83;*R6 $$3,0#31310162474203024125188417583966:caption]
[l288;i1121;b17;O9;~~~.1408;2 $$4,0#10431211400427159095818037425705:param]
[i448;a25;kKO9;*@(64)2 $$5,0#37138531426314131252341829483370:item]
[*+117 $$6,6#14700283458701402223321329925657:header]
[0 $$7,0#96390100711032703541132217272105:end]
[H6;0 $$8,0#05600065144404261032431302351956:begin]
[2 $$0,0#00000000000000000000000000000000:Default]
[{_}%EN-US 
[ {{10000@3 [s0; [*@(229)4 HeaderCtrl]]}}&]
[s7; &]
[s0;:HeaderCtrl`:`:class:%- [@(0.0.255)3 class][3  HeaderCtrl ][@(0.0.255)3 :][3  
][@(0.0.255)3 public][3  Upp][@(0.0.255)3 `::][3 Ctrl, ][@(0.0.255)3 public][3  
Upp][@(0.0.255)3 `::][3 CtrlFrame]&]
[s2; &]
[s2; 
@@image:1350&150
(A9gAGAAAAOj/AAAAAHic7ZnBDcIwDEWZmD0YgQ16QFxBYgEODMAKSN0BTlTgxG7SOo6TfuuJQxrqfv6Xg9Tx9RwBAAB82R/OAFSB5PCNQpkXl8Pqk9me03CE8FrdkUMndmxWOHLoyo7NCs/N4e6/uNsKlxZA7qZ780Q7EoW3S7rw8FOre+48nO1ewikb9+Wx0GUCZeGcZOSwih2Wz1CFPnJIDizhCIte4laIZKI9bEq+qGhHVHi09aw0n6TnsIlzOXw8zjthc+gvt0hWyB5FO2Qts0IULStEyv9DwRSV7orzUCWH8raipqvnMDokHdLBPMyKRPpmzuW2cqhikwHIoeK5LPx6K+0QTEmZ4YqWFaKDHE52/J7L3GEUvcStkHZhIOUYKNohm5IlzSct5nANzh3Jfa3Q0MTTFV6iO3K4wI5wyjmXpiW8XHe8X3Zix2aFCzl83K8AmMHl8HYZADBDOJdRKMtCDlEeCjlEeagphx8wHNk4)
&]
[s2; &]
[s0; [/ Derived from] Ctrl, [@(0.0.255) CtrlFrame]&]
[s0; &]
[s0; HeaderCtrl is used mainly for table headers. It can be set up 
to a certain column structure (in the code terminology, the individual 
header columns are called [/ tabs]) including the tabs`' visual 
characteristics (tab title names, icons etc.) and behavioral 
constraints (tab width limits, the ability to show / hide individual 
tabs).&]
[s0; &]
[s0; The individual tab widths are defined by three basic properties: 
the [/ logical tab width], its [/ minimum] and [/ maximum pixel width]. 
The minimum and maximum tab width are final pixel values defining 
constraints for physical (final) column widths. On the other 
hand, the logical tab widths are given in arbitrary units, which 
are multiplied by a certain scaling factor whenever the header 
control is laid out to fit the view size. Therefore normally 
their absolute magnitudes don`'t matter, just their ratios.&]
[s0; &]
[s0; The header control can operate in four different visual modes. 
Each mode effectively defines how the logical relative tab widths 
are fitted to the current view size:&]
[s0; &]
[s0;i150;O0; [* Proportional]: the tab widths are proportionally adjusted 
with respect to preset width constraints to fill the current 
view width;&]
[s0;i150;O0; [* ReduceLast]: every time a tab width is set and the total 
tab width exceeds the view size, the following tab widths (tabs 
to the right) are reduced in right`-to`-left order (beginning 
with the rightmost tab) to fit the view size.&]
[s0;i150;O0; [* ReduceNext]: every time a tab width is set and the total 
tab width exceeds the view size, the following tab widths (tabs 
to the right) are reduced in left`-to`-right order (beginning 
with the tab just after the tab being adjusted) to fit the view 
size.&]
[s0;i150;O0; [* Absolute]: the tab widths are never modified automatically, 
the logical header width can be smaller or greater than the actual 
view size. Whenever the total tab width exceeds the view size, 
the header can be scrolled to the left or right to pan its visible 
portion within the parent view.&]
[s0; &]
[s0; From the programmer`'s point of view, the HeaderCtrl takes complete 
control over the distribution of tabs and the user interface 
needed to adjust them. The host control can use the header control 
(typically during [/ Layout] or [/ Paint]) to obtain horizontal pixel 
positions of the individual tab breaks and use them to position 
and paint the column data.&]
[s0; &]
[s0; If Moving modifier is used, HeaderCtrl allows to reorder tabs 
using drag `& drop operation. Client code can identify the order 
using GetTabIndex method, which returns the `"original`" index 
for the tab.&]
[s0; &]
[s0; The HeaderCtrl implements the [/ frame interface]; when attached 
to a parent control using the [/ AddFrame] method, it positions 
itself automatically at the top of the control rectangle (above 
its view).&]
[s0; &]
[s0; In addition to the standard tab title functionality, the rectangular 
areas corresponding to the individual tabs can act as pseudo`-buttons 
invoking a certain functionality when clicked. Each header tab 
has a [/ WhenAction] callback; when set to a non`-null value, the 
header control starts to check for mouse clicks and executes 
the callback whenever the corresponding tab is clicked. When 
used to invoke popups, you can use the [/ GetTabRect] method to 
determine the actual location of a certain header tab and align 
the dropdown control with respect to the tab rectangle location.&]
[s0; &]
[s7;%- &]
[ {{10000F(128)G(128)@1 [s0; [* Public Method List]]}}&]
[s0; &]
[s5;K:HeaderCtrl`:`:GetTabRect`(int`):%- [*_^topic`:`/`/Core`/src`/Rect`_en`-us`#Rect`_`:`:struct^@0 R
ect]_[@0 GetTabRect]([*@(0.0.255) int]_[@3 i])&]
[s2; Returns the bounding box of a certain tab (in coordinates relative 
to the HeaderCtrl view). This can be used by controls using the 
header (like ArrayCtrl) to determine column break locations or 
by host applications for positioning dropdown controls (activated 
upon clicking a tab) relative to the tab box within the header.&]
[s4; [*C@3 i]-|Tab index (zero based).&]
[s4; [*/ Return value]-|rectangular tab bounding box within the HeaderCtrl.&]
[s0; &]
[s0; [* Hint:] to locate drop`-down controls (e.g. popup menus) relative 
to the tab rectangle, you have to transform the returned rectangle 
to screen coordinates. This can be done for example using the 
following code snippet:&]
[s0; &]
[s0; [C -|Rect tab2`_scr`_rect `= tab.GetTabRect(2) `+ tab.GetScreenView().TopLeft();]&]
[s7;%- &]
[s7;%- &]
[s8;%- &]
[s5;:HeaderCtrl`:`:Tab`(int`)const: [*@(0.0.255) const][* _][*_^topic`:`/`/CtrlLib`/src`/HeaderCtrl`_en`-us`#HeaderCtrl`:`:Column^@0 C
olumn][* `&]_[@0 Tab]([*@(0.0.255) int]_[@3 i][@0 )_][*@(0.0.255) const]&]
[s2; Returns the descriptive [* HeaderCtrl`::Column] structure of a 
given header tab. This constant version can be used to retrieve 
individual tab properties. For a thorough description of the 
[* Column] structure, see below.&]
[s4; [*C@3 i]-|Tab index within the header (zero based).&]
[s4; [*/ Return value]-|a (constant) reference to the [* Column] structure 
describing the tab.&]
[s7;%- &]
[s8; &]
[s5;:HeaderCtrl`:`:Tab`(int`): [*_^topic`:`/`/CtrlLib`/src`/HeaderCtrl`_en`-us`#HeaderCtrl`:`:Column^@0 C
olumn][%-* `&]_[@0 Tab]([*@(0.0.255) int]_[@3 i][@0 )]&]
[s2; Returns a (non`-constant) reference to the descriptive [* HeaderCtrl`::Column] 
structure of a given header tab. This can be used to set and 
retrieve individual tab properties (see below for a full description 
of the [* Column] structure).&]
[s4; [*C@3 i]-|Tab index (zero based).&]
[s4; [*/ Return value]-|a non`-constant reference to the [* Column] structure 
for the given tab.&]
[s7; &]
[s8; &]
[s5;K:Upp`:`:HeaderCtrl`:`:Add`(const char`*`,double`):%- [%%*_^topic`:`/`/CtrlLib`/src`/HeaderCtrl`_en`-us`#HeaderCtrl`:`:Column^@0 C
olumn][* `&]_[@0 Add]([*@(0.0.255) const][* _][*@(0.0.255) char]_[* `*][@3 text], 
[*@(0.0.255) double]_[@3 ratio]_`=_[@3 0])&]
[s2; Adds a new tab after (to the right of) all existing header tabs. 
The function returns a (non`-constant) reference to the [* HeaderCtrl`::Column] 
structure which can be further used to set up additional tab 
properties.&]
[s4; [*C@3 text]-|Tab (title) name.&]
[s4; [*C@3 ratio]-|Logical tab width.&]
[s4; [*/ Return value]-|a non`-constant reference to the [* Column] structure 
describing the newly added tab.&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:Add`(`):%- [%%*_^topic`:`/`/CtrlLib`/src`/HeaderCtrl`_en`-us`#HeaderCtrl`:`:Column^@0 C
olumn]`&_[@0 Add]()&]
[s2; Adds a new tab after (to the right of) all existing header tabs. 
This is identical to the above version with the [/ text] argument 
set to an empty string and [/ ratio] set to 0.&]
[s4; [*/ Return value]-|a non`-constant reference to the [* Column] structure 
describing the newly added tab.&]
[s7; &]
[s8; &]
[s5;K:Upp`:`:HeaderCtrl`:`:operator`[`]`(int`)const:%- [*@(0.0.255) const][* _][%%*_^topic`:`/`/CtrlLib`/src`/HeaderCtrl`_en`-us`#HeaderCtrl`:`:Column^@0 C
olumn]`&_[@0 operator`[`]]([*@(0.0.255) int]_[@3 i])_[*@(0.0.255) const]&]
[s2; Returns a (constant) reference to a given header tab. This is 
identical to the [/ const] version of the [* Tab] method.&]
[s4; [*C@3 i]-|Tab index (zero based).&]
[s4; [*/ Return value]-|a constant reference to the given header tab.&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:GetCount`(`)const:%- [*@(0.0.255) int][* _][@0 GetCount]()[* _][*@(0.0.255) c
onst]&]
[s2; Returns the current number of header tabs. Each [* Add] increases 
this value by one and [* Reset] sets it to 0 (the initial value).&]
[s4; [*/ Return value]-|Number of tabs.&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:Reset`(`):%- [*@(0.0.255) void]_[@0 Reset]()&]
[s2; Resets the header tab to its initial state (removes all tabs).&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:ShowTab`(int`,bool`):%- [*@(0.0.255) void][* _][@0 ShowTab]([*@(0.0.255) i
nt]_[@3 i], [*@(0.0.255) bool]_[@3 show]_`=_true)&]
[s2; Shows or hides a certain header tab.&]
[s4; [*C@3 i]-|tab index (zero based)&]
[s4; [*C@3 show]-|flag indicating whether the tab should be shown ([* true]) 
or hidden ([* false]).&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:HideTab`(int`):%- [*@(0.0.255) void][* _][@0 HideTab]([*@(0.0.255) int]_[@3 i
])&]
[s2; Hides a certain header tab. This is identical to [* ShowTab(i, 
false)].&]
[s4; [*C@3 i]-|tab index (zero based)&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:IsTabVisible`(int`):%- [*@(0.0.255) bool][* _][@0 IsTabVisible]([*@(0.0.255) i
nt]_[@3 i])&]
[s2; Checks for visibility of a certain tab.&]
[s4; [*C@3 i]-|tab index (zero based).&]
[s4; [*/ Return value]-|[* false] `= hidden, [* true] `= shown.&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:SetTabRatio`(int`,double`):%- [*@(0.0.255) void][* _][@0 SetTabRatio]([*@(0.0.255) i
nt]_[@3 i], [*@(0.0.255) double]_[@3 ratio])&]
[s2; Sets the logical tab width (ratio) of a given tab.&]
[s4; [*C@3 i]-|tab index&]
[s4; [*C@3 ratio]-|logical tab width.&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:GetTabRatio`(int`)const:%- [*@(0.0.255) double][* _][@0 GetTabRatio]([*@(0.0.255) i
nt]_[@3 i])_[*@(0.0.255) const]&]
[s2; Retrieves the current logical width of a certain tab. The logical 
tab width can be set using the [* SetTabRatio] method (or using 
the [* SetRatio] method for an individual [* HeaderCtrl`::Column] 
object) or by dragging the tab breaks using the mouse.&]
[s4; [*C@3 i]-|tab index (zero based)&]
[s4; [*/ Return value]-|current logical tab width&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:SetTabWidth`(int`,int`):%- [*@(0.0.255) void][* _][@0 SetTabWidth]([*@(0.0.255) i
nt]_[@3 i], [*@(0.0.255) int]_[@3 cx])&]
[s2; Sets the given header tab to a physical (pixel) size. This also 
modifies the logical (relative) tab width accordingly.&]
[s4; [*C@3 i]-|tab index (zero based)&]
[s4; [*C@3 cx]-|tab pixel size&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:GetTabWidth`(int`):%- [*@(0.0.255) int][* _][@0 GetTabWidth]([*@(0.0.255) i
nt]_[@3 i])&]
[s2; Returns the physical (pixel) width of a given header tab. Remember 
that (unless the HeaderCtrl is in the [* Scroll] mode) the physical 
tab widths can change with the parent view size. Algorithms for 
long`-term manipulation of tab sizes (typically serialization) 
should always count on the logical tab widths.&]
[s4; [*C@3 i]-|tab index (zero based)&]
[s4; [*/ Return value]-|physical (pixel) tab width. Note that this function 
isn`'t [/ const], because the header control uses a lazy algorithm 
to lay out the header control, and during the call to [* GetTabWidth] 
it may show that the tabs need to be newly laid out.&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:SwapTabs`(int`,int`):%- [*@(0.0.255) void]_[@0 SwapTabs]([*@(0.0.255) i
nt]_[@3 first], [*@(0.0.255) int]_[@3 second])&]
[s2; Swaps tabs [%-*@3 first] and [%-*@3 second].&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:MoveTab`(int`,int`):%- [*@(0.0.255) void]_[@0 MoveTab]([*@(0.0.255) int
]_[@3 from], [*@(0.0.255) int]_[@3 to])&]
[s2; Moves tab to another position.&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:GetTabIndex`(int`)const:%- [*@(0.0.255) int]_[@0 GetTabIndex]([*@(0.0.255) i
nt]_[@3 i])&]
[s2; Returns `"original`" index of Tab.&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:FindIndex`(int`)const:%- [*@(0.0.255) int][* _][@0 FindIndexTab]([*@(0.0.255) i
nt]_[@3 ndx])&]
[s2; Finds a current position of tab with original index [%-*@3 ndx].&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:StartSplitDrag`(int`):%- [*@(0.0.255) void]_[@0 StartSplitDrag]([*@(0.0.255) i
nt]_[@3 s])&]
[s2; Starts the header tab drag `& drop for a given tab break.&]
[s4; [*C@3 s]-|break index (zero `= left side of tab 0).&]
[s7; &]
[s8; &]
[s5;K:Upp`:`:HeaderCtrl`:`:GetSplit`(int`):%- [*@(0.0.255) int]_[@0 GetSplit]([*@(0.0.255) i
nt]_[@3 x])&]
[s2; Locates the header tab break corresponding to a given [/ x] coordinate 
(relative to the header control). This can be used by the parent 
controls to check whether the mouse cursor hovers above a tab 
break (e.g. [* ArrayCtrl] uses this function to check whether to 
display the horizontal resizing cursor).&]
[s4; [*C@3 x]-|horizontal pixel coordinate (relative to the header control 
bounding box).&]
[s4; [*/ Return value]-|Index of tab break (in the range `[0..GetCount()`]) 
or `-1 when there is no tab break in the vicinity of a given 
point.&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:GetScroll`(`)const:%- [*@(0.0.255) int]_[@0 GetScroll]()_[*@(0.0.255) c
onst]&]
[s2; [* Absolute] mode only: returns pixel offset defining the current 
origin of the (potentially scrolled) header. For non`-scrolling 
visual modes, this function always returns 0 (in non`-scrolling 
modes the left side of first tab always aligns with the left 
side of parent view).&]
[s4; [*/ Return value]-|Number of pixels by which the header control 
is currently scrolled in the horizontal direction. The physical 
[/ x] coordinate of a tab edge (relative to parent view) can be 
calculated by subtracting this value from its logical coordinate 
(relative to leftmost header edge).&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:IsScroll`(`)const:%- [*@(0.0.255) bool]_[@0 IsScroll]()_[*@(0.0.255) co
nst]&]
[s2; Checks whether the header control is currently in scrolling 
mode (i.e., whether it is in the [* Absolute] visual mode and its 
total tab width exceeds current view size). When [* IsScroll] returns 
[* true], the [* GetScroll] method can be used to retrieve the current 
horizontal scrollbar position.&]
[s4; [*/ Return value]-|[* true] `= scrolling header, [* false ]`= non`-scrolling 
header.&]
[s7; &]
[s8;%- &]
[s5;:Upp`:`:HeaderCtrl`:`:SetHeight`(int`):%- [*@(0.0.255) void][*@0  
][@0 SetHeight(][*@(0.0.255) int][*@0  ][@3 cy][@0 )]&]
[s2; Sets the header control`'s pixel height.&]
[s2; [%-*@3 cy] ...........................................height in 
pixels&]
[s7;%- &]
[s8; &]
[s5;K:HeaderCtrl`:`:GetHeight`(`)const:%- [*@(0.0.255) int]_[@0 GetHeight]()_[*@(0.0.255) c
onst]&]
[s2; Determines the pixel height of the header control. This is equal 
to the maximum of all the individual tab heights (depending on 
the tab title font and icon sizes).&]
[s4; [*/ Return value]-|HeaderCtrl pixel height.&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:Invisible`(bool`):%- [*_^topic`:`/`/CtrlLib`/src`/HeaderCtrl`_en`-us`#HeaderCtrl`:`:class^ H
eaderCtrl][* `&]_[@0 Invisible]([*@(0.0.255) bool]_[@3 inv])&]
[s2; When called with a [* true] argument, makes the header zero height 
in frame mode (the tab placement routines still work but the 
header itself remains hidden).&]
[s4; [*C@3 inv]-|[* true] `= hide the header, [* false] `= show it.&]
[s4; [*/ Return value]-|[* `*this]&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:Track`(bool`):%- [*_^topic`:`/`/CtrlLib`/src`/HeaderCtrl`_en`-us`#HeaderCtrl`:`:class^ H
eaderCtrl][* `&]_[@0 Track]([*@(0.0.255) bool]_[@3 `_track]_`=_true)&]
[s2; Sets whether the HeaderCtrl and its parent view contents should 
be `'animated`' during repositioning the tab breaks using mouse 
drag `& drop. When [* `_track] is set to [* true], the header and 
its parents repaint is requested every time the mouse moves during 
the drag `& drop. When set to [* false], the header and the parent 
control get repainted only after the drag `& drop is finished. 
It is wise to set this value depending on the complexity of the 
data shown `'beneath`' the header (usually in an ArrayCtrl) and 
on the expected target hardware because the track mode is much 
more demanding with respect to computational time spent during 
the necessary multiple repaints.&]
[s4; [*C@3 `_track]-|[* true] `= regenerate header and its parent dynamically 
during drag `& drop, [* false] `= only after it`'s finished.&]
[s4; [*/ Return value]-|[* `*this]&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:NoTrack`(`):%- [*_^topic`:`/`/CtrlLib`/src`/HeaderCtrl`_en`-us`#HeaderCtrl`:`:class^ H
eaderCtrl][* `&]_[@0 NoTrack]()&]
[s2; Turns off track mode. This is identical to [* Track(false)].&]
[s4; [*/ Return value]-|[* `*this]&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:Proportional`(`):%- [*_^topic`:`/`/CtrlLib`/src`/HeaderCtrl`_en`-us`#HeaderCtrl`:`:class^ H
eaderCtrl][* `&]_[@0 Proportional]()&]
[s2; Switches the HeaderCtrl to the [/ proportional] mode. In proportional 
mode, the individual logical tab widths are always recalculated 
to physical (pixel) widths by scaling them using a common multiplication 
factor in order to fit the whole header into the view width.&]
[s4; [*/ Return value]-|[* `*this]&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:ReduceNext`(`):%- [*_^topic`:`/`/CtrlLib`/src`/HeaderCtrl`_en`-us`#HeaderCtrl`:`:class^ H
eaderCtrl][* `&]_[@0 ReduceNext]()&]
[s2; Switches the HeaderCtrl to the [/ reduce next] mode. Every time 
a tab width is set in this mode and the total tab width exceeds 
the view size, the following tab widths (tabs to the right) are 
reduced in left`-to`-right order (beginning with the tab just 
after the tab being adjusted) to fit the view size.&]
[s4; [*/ Return value]-|[* `*this]&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:ReduceLast`(`):%- [*_^topic`:`/`/CtrlLib`/src`/HeaderCtrl`_en`-us`#HeaderCtrl`:`:class^ H
eaderCtrl][* `&]_[@0 ReduceLast]()&]
[s2; Switches the HeaderCtrl to the [/ reduce last] mode. Every time 
a tab width is set in this mode and the total tab width exceeds 
the view size, the following tab widths (tabs to the right) are 
reduced in right`-to`-left order (beginning with the rightmost 
tab) to fit the view size.&]
[s4; [*/ Return value]-|[* `*this]&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:Absolute`(`):%- [*_^topic`:`/`/CtrlLib`/src`/HeaderCtrl`_en`-us`#HeaderCtrl`:`:class^ H
eaderCtrl][* `&]_[@0 Absolute]()&]
[s2; Switches the HeaderCtrl to the [/ absolute] (scroll) mode. In 
this mode the tab widths are never modified automatically, the 
logical header width can be smaller or greater than the actual 
view size. Whenever the total tab width exceeds the view size, 
the header can be scrolled to the left or right to pan its visible 
portion within the parent view.&]
[s4; [*/ Return value]-|[* `*this]&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:Moving`(bool`):%- [*_^topic`:`/`/CtrlLib`/src`/HeaderCtrl`_en`-us`#HeaderCtrl`:`:class^ H
eaderCtrl][* `&]_[@0 Moving]([@(0.0.255) bool]_[@3 b]_`=_true)&]
[s2; Activates mode when tabs can be rearranged by dragging them. 
Default is inactive.&]
[s7;%- &]
[s0; &]
[s0; [* Notification callbacks]&]
[s0; &]
[s7; &]
[s5;K:HeaderCtrl`:`:WhenLayout:~~~320;%- [*_^topic`:`/`/Core`/src`/Function`_en`-us`#Upp`:`:Event^@0 E
vent]_[@0 WhenLayout]&]
[s2; This callback is executed whenever the header control gets laid 
out (whenever the tab positions and/or widths change).&]
[s7; &]
[s5;K:HeaderCtrl`:`:WhenScroll:%- [*_^topic`:`/`/Core`/src`/Function`_en`-us`#Upp`:`:Event^@0 E
vent]_[@0 WhenScroll]&]
[s2; This callback is executed whenever the header control gets scrolled 
([/ absolute] mode only).&]
[s7; &]
[s5;K:HeaderCtrl`:`:WhenScrollVisibility:%- [*_^topic`:`/`/Core`/src`/Function`_en`-us`#Upp`:`:Event^@0 E
vent]_[@0 WhenScrollVisibility]&]
[s2; This callback is executes whenever its scrollbar appears or 
disappears (whenever the return value of the [* IsScroll] method 
changes).&]
[s7; &]
[s0;%- &]
[ {{10000F(128)G(128)@1 [s0; [* Public Static Method List]]}}&]
[s7; &]
[s5;K:HeaderCtrl`:`:GetStdHeight`(`):%- static_[@(0.0.255) int]_[@0 GetStdHeight]()&]
[s2; Returns the standard header control height (when there are no 
icons and the standard font is used in all tabs).&]
[s4; [*/ Return value]-|standard header control height&]
[s7; &]
[s8; &]
[s5;:HeaderCtrl`:`:StyleDefault`(`):%- [*@(0.0.255) static][*@0  ][*@(0.0.255) const][*@0  
][*_^topic`:`/`/CtrlLib`/src`/HeaderCtrl`_en`-us`#HeaderCtrl`:`:Style^@0 HeaderCtrl
][*_^topic`:`/`/CtrlLib`/src`/HeaderCtrl`_en`-us`#HeaderCtrl`:`:Style^@(0.0.255) `:
:][*_^topic`:`/`/CtrlLib`/src`/HeaderCtrl`_en`-us`#HeaderCtrl`:`:Style^@0 Style][*@(0.0.255) `&
][@0  StyleDefault()]&]
[s2; Returns the standard style for HeaderCtrl. This style can be 
globally overridden for all controls within the application.&]
[s0;l288; [*/ Return value][/ .................-|...........]a reference 
to the default global style instance.&]
[s0;%- &]
[ {{10000@3 [s0; [*@(229)4 HeaderCtrl`::Column]]}}&]
[s7;%- &]
[s1;:HeaderCtrl`:`:Column:%- [*@(0.0.255)3 class][*@0;3  ][@0;3 Column][*@0;3  
][*@(0.0.255)3 :][*@0;3  ][*@(0.0.255)3 public][*@0;3  Upp][*@(0.0.255)3 `::][*@0;3 LabelBase]&]
[s2; &]
[s0;%- [%%/ Derived from][%%  ]LabelBase&]
[s0; &]
[s0; The [* HeaderCtrl`::Column] structure represents an individual 
header tab. HeaderCtrl methods for tab insertion and editation 
typically return a reference to this [/ Column] class which can 
be used afterwards to program the various tab properties.&]
[s0; &]
[s0; The set methods return a reference to [* `*this] ; this allows 
multiple tab properties to be set using a single C`+`+ statement 
with repeated use of the dot operator, e.g.:&]
[s0; &]
[s0; [C -|headerctrl.Add().Min(10).Max(20).Margin(3);]&]
[s0;3 &]
[s7;%- &]
[ {{10000F(128)G(128)@1 [s0; [* Public Method List]]}}&]
[s0;3 &]
[s5;K:HeaderCtrl`:`:Column`:`:Min`(int`):%- [%%*_^topic`:`/`/CtrlLib`/src`/HeaderCtrl`_en`-us`#HeaderCtrl`:`:Column^@0 C
olumn][*@0 `&]_[@0 Min]([*@(0.0.255) int]_[@3 `_min])&]
[s2; Sets minimum tab pixel size. The default value is 0 (the tab 
can be shrunk arbitrarily and can disappear altogether at a certain 
moment).&]
[s4; [%-*C@3 `_min]-|Minimum tab width in pixels.&]
[s4; [*/ Return value]-|[* `*this]&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:Column`:`:Max`(int`):%- [%%*_^topic`:`/`/CtrlLib`/src`/HeaderCtrl`_en`-us`#HeaderCtrl`:`:Column^@0 C
olumn][*@0 `&]_[@0 Max]([*@(0.0.255) int]_[@3 `_max])&]
[s2; Sets maximum tab pixel size. The default value is [/ INT`_MAX] 
(unlimited).&]
[s4; [%-*C@3 `_max]-|Maximum tab width in pixels.&]
[s4; [*/ Return value]-|[* `*this]&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:Column`:`:MinMax`(int`,int`):%- [%%*_^topic`:`/`/CtrlLib`/src`/HeaderCtrl`_en`-us`#HeaderCtrl`:`:Column^@0 C
olumn][*@0 `&]_[@0 MinMax]([*@(0.0.255) int]_[@3 m], [*@(0.0.255) int]_[@3 n])&]
[s2; Sets both minimum and maximum tab pixel size at the same time. 
This has the same effect as [* .Min(m).Max(n)].&]
[s4; [%-*C@3 m]-|Minimum tab width in pixels.&]
[s4; [%-*C@3 n]-|Maximum tab width in pixels.&]
[s4; [*/ Return value]-|[* `*this]&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:Column`:`:Fixed`(int`):%- [%%*_^topic`:`/`/CtrlLib`/src`/HeaderCtrl`_en`-us`#HeaderCtrl`:`:Column^@0 C
olumn][*@0 `&]_[@0 Fixed]([*@(0.0.255) int]_[@3 f])&]
[s2; Sets both minimum and maximum tab pixel size to the same value, 
effectively making the tab width constant. Equal to [* .MinMax(f, 
f)].&]
[s4; [%-*C@3 f]-|Fixed tab width in pixels.&]
[s4; [*/ Return value]-|[* `*this]&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:Column`:`:SetRatio`(double`):%- [%%*_^topic`:`/`/CtrlLib`/src`/HeaderCtrl`_en`-us`#HeaderCtrl`:`:Column^@0 C
olumn][*@0 `&]_[@0 SetRatio]([*@(0.0.255) double]_[@3 ratio])&]
[s2; Sets logical (relative) tab width. The logical tab width (together 
with logical widths of other tabs and the minimum / maximum width 
constraints) is used to calculate the final pixel size of each 
tab according to the current header visual mode.&]
[s4; [%-*C@3 ratio]-|relative tab width (a generic floating`-point value)&]
[s4; [*/ Return value]-|[* `*this]&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:Column`:`:SetMargin`(int`):%- [%%*_^topic`:`/`/CtrlLib`/src`/HeaderCtrl`_en`-us`#HeaderCtrl`:`:Column^@0 C
olumn][*@0 `&]_[@0 SetMargin]([*@(0.0.255) int]_[@3 m])&]
[s2; Sets horizontal tab margin size, the number of pixels to deflate 
the tab rectangle horizontally to obtain the final `"column data`" 
rectangle. In [/ ArrayCtrl], the tab margin areas are used to paint 
the grid lines and the inverted selection rectangle outside of 
the table cells.&]
[s4; [%-*C@3 m]-|Horizontal tab margin size in pixels.&]
[s4; [*/ Return value]-|[* `*this]&]
[s7; &]
[s8; &]
[s5;K:HeaderCtrl`:`:Column`:`:GetMargin`(`)const:%- [*@(0.0.255) int]_[@0 GetMargin]()_[*@(0.0.255) c
onst]&]
[s2; Returns current tab margin width in pixels.&]
[s4; [*/ Return value]-|[* `*this]&]
[s7; &]
[s0; &]
[s0; [* Notification callbacks]&]
[s0; &]
[s7; &]
[s5;K:HeaderCtrl`:`:Column`:`:WhenAction:%- [*_^topic`:`/`/Core`/src`/Function`_en`-us`#Upp`:`:Event^@0 E
vent]_[@0 WhenAction]&]
[s2; The tab action callback. When set to a non`-null value, the 
header control starts to check for mouse clicks within this tab 
and calls this callback whenever the corresponding tab is clicked.&]
[s7; &]
[s5;K:HeaderCtrl`:`:Column`:`:WhenBar:%- [*_^topic`:`/`/Core`/src`/Function`_en`-us`#Upp`:`:Event^@0 E
vent][* <Bar`&>]_[@0 WhenBar]&]
[s2; Provides am optional context menu for header tab.  &]
[s0;%- &]
[ {{10000@3 [s0; [*@(229)4 HeaderCtrl`::Style]]}}&]
[s7;%- &]
[s0;:HeaderCtrl`:`:Style:%- [@(0.0.255)3 struct][3  Style ][@(0.0.255)3 :][3  
ChStyle<Style>]&]
[s2;%- &]
[s0;%- [%%/ Derived from][%%  ]ChStyle<Style>&]
[s0;%- &]
[s0;%- The structure represents the style for HeaderCtrl.&]
[s0;%- &]
[s7;%- ]]