Inheritance diagram

Collaboration diagram

Description

How to use

SFYTabControl is the abstract base class for all tab controls.

Tab control is the control to manage a container(SFYContainer), which is called "tab page" hereafter, in the tabular format.

The size of the tab control region is set with the SFYResponder::SetRealBound function.

A tab page can be appended by setting the tab control to the parent responder of the tab page with the SFYResponder::SetParent function.

Immediately after appending the tab page, its real region is automatically set to the return value of the SFYTabControl::GetContentBound function.

	Real region of the tab page
	The real region of the tab page is set to the value obtained by the SFYTabControl::GetContentBound function. In the implementation of the concrete class, it is necessary to set the value of above region using the SFYTabControl::SetContentBound function.

The drawing or behaviour of the tab page in the tab control differs depending on its state as follows:

	Note
	The above label is a label which corresponds to the tab page displayed in the tab region inside the tab control.

	Implementation of the drawing or behaviour on focus of the tab page depending on its state
	The above behaviour of the tab page depending on its state is implemented in the SFYTabControl class. However, drawing of the tab label needs to be implemented in the concrete class inheriting from the SFYTabControl class.

Meaning of the control values and their limitations

The minimum value obtained by the SFYControl::GetMinimumValue function is always "0". The current value obtained by the SFYControl::GetCurrentValue function represents the index of currently selected tab page. If the page does not exist, it will be "-1". To set the current value, not the SFYControl::SetCurrentValue function but the SFYTabControl::FocusPage function must be used. The maximum value obtained by the SFYControl::GetMaximumValue function represents the number of tab pages in the tab control. [* This function is to be discontinued in the future. To obtain the number of tab pages, call the SFYTabControl::GetPageCount function.] The field value obtained by the SFYTabControl::GetFieldValue function represents the number of tab labels which are displayed on the screen. It needs to be set with an integer value more than 0 using the SFYTabControl::SetFieldValue function. The top value obtained by the SFYTabControl::GetTopValue function represents the index of tab page which is displayed in the most left side on the screen.

Displaying the tab page(SFZTabPage) and its prohibit functions

To display the tab page, call the SFYTabControl::FocusPage function with its index as argument when the "focus" state of the tab control is "ON". Since there is a possibility that the selected tab may not match with the currently displayed tab page, it is not prohibited to call tab page's function such as SFYResponder::ToFront or SFYResponder::SetStateFocus which may chage the order relation of the tab pages.

Deleting the tab page from the tab control

The method to delete the tab page from the tab control dynamically is as follows: CASE 1. Preserve the tab page: Set the tab page's parent responder to SFYResponderSmp::EmptyInstance() by calling the SFYResponder::SetParent function. CASE 2. Use the tab page for another tab control: Set the tab page's parent responder to another tab control by calling the SFYResponder::SetParent function. CASE 3. Destroy the tab page: Terminate the tab page by calling the SFYResponder::Terminate function. The code to delete the tab page from the tab control is as follows: // CASE 1. Preserve the tab page (set tab page's parent to the empty instance): page->SetParent(SFYResponder::EmptyInstance()); // CASE 2. Use tab page for another tab control (set tab page's parent to another tab control): SFYTabControlSmp othertab; page->SetParent(othertab); // CASE 3. Destroy tab page: page->Terminate();

Reference

SFYContainer | SFYResponder::SetRealBound | Real Region | State

Member

Description

This constructor performs the initializations as follows:

	Note
	In a responder inheriting from SFYTabControl, the corresponding handler will be called when one of the above events occurs.

Reference

SFYResponder::SetType | SFYTabControl::CodeEnum | SFYResponder::SetParent | SFYResponder::SetState | SFZScrollBarControl::NewInstance | SFYTabControl::GetScrollBarControl | SFYScrollBarControl::SetOrientation | SFYScrollBarControl::SetOrientation | SFYTabControl::SetScrollBarWidth | SFYScrollBarControl::OrientationEnum | SFYControl::SetMaximumValue | SFYControl::SetCurrentValue | SFYTabControl::SetFieldValue | SFYTabControl::GetTabLoop | SFYTabControl::SetFocusLeftKey | SFYTabControl::SetFocusRightKey | SFZScrollBarControl | SFXEvent | SFXRGBColor | Type | State | Event | Key Event[SFEVT_KEY]

Description

This destructor does nothing.

Description

This function adjusts the real region and the virtual region of all the pages of this tab control.

	Note
	SFYTabControl::AdjustPages() is the function which is called in the implementation of HandleBoundReal or HandleBoundVirtual function.

Example

When the real region of tab control is changed, the corresponding pages need to be adjusted as below.

Void CustomTabControl::HandleBoundReal(Void)
{
    SetVirtualBound(SFXRectangle(SFXGrid::ZeroInstance(), GetRealBound().GetSize()));
    AdjustPages();
    Invalidate();
    return;
}

Reference

Real Region | Virtual Region

Return value

Index of the first among the pages(or containers) of this tab control, which match the specified condition.

If there is no page which matches the specified condition, "-1" will be returned.

Description

This function gets the first index among the pages(or containers) of this tab control, which match the specified condition on the visible, active, and enable states.

The index of the returned value is for all the pages(or containers) which belong to this tab control.

Example

There are four methods to use this function as below.

// since SFYTabControl is abstract class, 
// it is necessary to instantiate the tab control using the concrete class which inherits from SFYTabControl
SFYTabControlSmp tab;
SInt32 index;

// suppose each container instance has already been created
SFYContainerSmp a; a->SetState(false, false, false, false);
SFYContainerSmp b; b->SetState(true, false, false, false);
SFYContainerSmp c; c->SetState(true, true, false, false);
SFYContainerSmp d; d->SetState(true, true, true, false);
a->SetParent(tab);
b->SetParent(tab);
c->SetParent(tab);
d->SetParent(tab);

// get the first index among all the pages
index = tab->FirstIndexOf(false, false, false);  // index = 0

// get the first index among all the "visible" pages
index = tab->FirstIndexOf(true, false, false);   // index = 1

// get the first index among all the "active" pages
index = tab->FirstIndexOf(true, true, false);    // index = 2

// get the first index among all the "enable" pages
index = tab->FirstIndexOf(true, true, true);     // index = 3

Reference

SFYTabControl::LastIndexOf | SFYTabControl::NextIndexOf | SFYTabControl::PrevIndexOf

Description

This function moves the focus to the tab page left next to the currently focused page of this tab control.

In case the currently focused page is the first tab page, the result depends on the value of SFYTabControl::GetTabLoop().

If the value is "true", the focus will be moved to the last tab page.

If the value is "false", the focus will remain at the first tab page.

Reference

SFYTabControl::FocusRight | SFYTabControl::GetTabLoop | SFYTabControl::SetTabLoop

Return value

Description

This function moves the focus(*) to the specified tab page(or container) of this tab control.

* This function needs to be called only when the tab control is also in the "focus" state.

Reference

SFYControl::GetCurrentValue

Description

This function moves the focus to the tab page right next to the currently focused page of this tab control.

In case the currently focused page is the last tab page, the result depends on the value of SFYTabControl::GetTabLoop().

If the value is "true", the focus will be moved to the first tab page.

If the value is "false", the focus will remain at the last tab page.

Reference

SFYTabControl::FocusLeft | SFYTabControl::GetTabLoop| SFYTabControl::SetTabLoop

Description

This function gets the index of the last page on the right side which is currently displayed on this tab control.

Reference

SFYTabControl::GetTopValue

Description

This function gets the real region of the page(or container) which will be set for this tab control.

When the SFYTabControl::AdjustPages function is called, the real region of page will be set using this function.

Reference

SFYTabControl::SetContentBound | SFYTabControl::AdjustPages | Real Region

Description

This function gets the number of tab pages which is displayed at the same time in this tab control.

Reference

SFYTabControl::SetFieldValue

Return value

Key of AVKType with which the focus is moved to the page(or container) left next to the currently focused page(or container) of this tab control.

Description

This function gets the key with which the focus is moved to the page(or container) left next to the currently focused page(or container) of this tab control.

Reference

SFYTabControl::SetFocusLeftKey | SFYTabControl::FocusLeft

Return value

Key of AVKType with which the focus is moved to the page(or container) right next to the currently focused page(or container) of this tab control.

Description

This function gets the key with which the focus is moved to the page(or container) right next to the currently focused page(or container) of this tab control.

Reference

SFYTabControl::SetFocusRightKey | SFYTabControl::FocusRight

Return value

Index of the specified page(or container) of this tab control.

If the specified page(or container) does not exist, "-1" will be returned.

Description

This function gets the index of the specified page(or container) of this tab control.

Reference

SFYTabControl::GetPage

Description

This function gets the number of all pages(or containers) of this tab control.

	Caution
	Since this function is deprecated, use the SFYTabControl::GetPageCount function instead.

Reference

SFYTabControl::GetPageCount

Return value

Page(or container) of this tab control, of which index is specified in the argument.

If such a page does not exist, SFYContainerSmp::EmptyInstance() will be returned.

Description

This function gets the page(or container) of this tab control whose index is specified in the argument.

Reference

SFYTabControl::GetIndex | SFXResponderPointer::EmptyInstance | SFYContainer

Description

This function gets the number of the pages(or containers) of this tab control which match the specified condition on the visible, active, and enable states. If no condition is specified, the number of all pages will be returned.

Example

There are four methods to use this function as below.

// since SFYTabControl is abstract class, 
// it is necessary to instantiate the tab control using the concrete class which inherits from SFYTabControl
SFYTabControlSmp tab;
SInt32 num;

// suppose each container instance has already been created
SFYContainerSmp a; a->SetState(false, false, false, false);
SFYContainerSmp b; b->SetState(true, false, false, false);
SFYContainerSmp c; c->SetState(true, true, false, false);
SFYContainerSmp d; d->SetState(true, true, true, false);
a->SetParent(tab);
b->SetParent(tab);
c->SetParent(tab);
d->SetParent(tab);

// get the number of all the pages
num = tab->GetPageCount();                       // num = 4

// get the number of all the pages(performance is bad with this method)
num = tab->GetPageCount(false, false, false);    // num = 4

// get the number of all the "visible" pages
num = tab->GetPageCount(true, false, false);     // num = 3

// get the number of all the "active" pages
num = tab->GetPageCount(true, true, false);      // num = 2

// get the number of all the "enable" pages
num = tab->GetPageCount(true, true, true);       // num = 1

Description

This function gets the safe page of this tab control which will be displayed when the specified page does not exist or is invalid.

Description

This function gets the background color(SFXRGBColor) of the safe page(or default page) of this tab control, which will be displayed when the specified page does not exist or is invalid.

Reference

SFYTabControl::SetSafePageBackgroundColor

Description

This function gets the scroll bar control which is internally used by this tab control.

Reference

SFYTabControl::SetScrollBarControl

Return value

Width of the scroll bar control which is internally used by this tab control. [pixels]

Description

This function gets the width of the scroll bar control which is internally used by this tab control. [pixels]

Reference

SFYTabControl::SetScrollBarWidth

Return value

Description

This function gets the value of tab-loop flag indicating whether or not the focus at the first or last page can be moved to the last or first page respectively.

Reference

SFYTabControl::SetTabLoop

Description

This function gets the index of the first page on the left side which is currently displayed on this tab control.

Reference

SFYTabControl::GetBottomValue

Return value

Index of the last among the pages(or containers) of this tab control which match the specified condition.

If there is no page which matches the specified condition, "-1" will be returned.

Description

This function gets the last index among the pages(or containers) of this tab control which match the specified condition on the visible, active, and enable states.

The index of the returned value is for all the pages(or containers) which belong to this tab control.

Example

There are four methods to use this function as below.

// since SFYTabControl is abstract class, 
// it is necessary to instantiate the tab control using the concrete class which inherits from SFYTabControl
SFYTabControlSmp tab;
SInt32 index;

// suppose each container instance has already been created
SFYContainerSmp a; a->SetState(false, false, false, false);
SFYContainerSmp b; b->SetState(true, false, false, false);
SFYContainerSmp c; c->SetState(true, true, false, false);
SFYContainerSmp d; d->SetState(true, true, true, false);
a->SetParent(tab);
b->SetParent(tab);
c->SetParent(tab);
d->SetParent(tab);

// get the last index among all the pages
index = tab->LastIndexOf(false, false, false);   // index = 3

// get the last index among all the "visible" pages
index = tab->LastIndexOf(true, false, false);    // index = 3

// get the last index among all the "active" pages
index = tab->LastIndexOf(true, true, false);     // index = 3

// get the last index among all the "enable" pages
index = tab->LastIndexOf(true, true, true);      // index = 3

Reference

SFYTabControl::FirstIndexOf | SFYTabControl::NextIndexOf | SFYTabControl::PrevIndexOf

Return value

Next index of the specified index among the pages(or containers) of this tab control which match the specified condition.

If there is no page which matches the specified condition, "-1" will be returned.

Description

This function gets the next index of the specified index among the pages(or containers) of this tab control which match the specified condition on the visible, active, and enable states.

The index of the returned value is for all the pages(or containers) which belong to this tab control.

Example

There are four methods to use this function as below.

// since SFYTabControl is abstract class, 
// it is necessary to instantiate the tab control using the concrete class which inherits from SFYTabControl
SFYTabControlSmp tab;
SInt32 index;

// suppose each container instance has already been created
SFYContainerSmp a; a->SetState(true, true, true, false);
SFYContainerSmp b; b->SetState(false, false, false, false);
SFYContainerSmp c; c->SetState(true, false, false, false);
SFYContainerSmp d; d->SetState(true, true, false, false);
SFYContainerSmp e; e->SetState(true, true, true, false);
a->SetParent(tab);   // page of the index "0"
b->SetParent(tab);
c->SetParent(tab);
d->SetParent(tab);
e->SetParent(tab);

// get the next index starting at the index "0" among all the pages
index = tab->NextIndexOf(0, false, false, false);  // index = 1

// get the next index starting at the index "0" among all the "visible" pages
index = tab->NextIndexOf(0, true, false, false);   // index = 2

// get the next index starting at the index "0" among all the "active" pages
index = tab->NextIndexOf(0, true, true, false);    // index = 3

// get the next index starting at the index "0" among all the "enable" pages
index = tab->NextIndexOf(0, true, true, true);     // index = 4

Reference

SFYTabControl::FirstIndexOf | SFYTabControl::LastIndexOf | SFYTabControl::PrevIndexOf

Return value

Previous index of the specified index among the pages(or containers) of this tab control which match the specified condition.

If there is no page which matches the specified condition, "-1" will be returned.

Description

This function gets the previous index of the specified index among the pages(or containers) of this tab control which match the specified condition on the visible, active, and enable states.

The index of the returned value is for all the pages(or containers) which belong to this tab control.

Example

There are four methods to use this function as below.

// since SFYTabControl is abstract class, 
// it is necessary to instantiate the tab control using the concrete class which inherits from SFYTabControl
SFYTabControlSmp tab;
SInt32 index;

// suppose each container instance has already been created
SFYContainerSmp a; a->SetState(true, true, true, false);
SFYContainerSmp b; b->SetState(false, false, false, false);
SFYContainerSmp c; c->SetState(true, false, false, false);
SFYContainerSmp d; d->SetState(true, true, false, false);
SFYContainerSmp e; e->SetState(true, true, true, false);
a->SetParent(tab);
b->SetParent(tab);
c->SetParent(tab);
d->SetParent(tab);   // page of index "3"
e->SetParent(tab);

// get the previous index starting at the index "3" among all the pages
index = tab->PrevIndexOf(3, false, false, false);  // index = 2

// get the previous index starting at the index "3" index among all the "visible" pages
index = tab->PrevIndexOf(3, true, false, false);   // index = 2

// get the previous index starting at the index "3" among all the "active" pages
index = tab->PrevIndexOf(3, true, true, false);    // index = 0

// get the previous index starting at the index "3" index among all the "enable" pages
index = tab->PrevIndexOf(3, true, true, true);     // index = 0

Reference

SFYTabControl::FirstIndexOf | SFYTabControl::LastIndexOf | SFYTabControl::NextIndexOf

Description

This function sets the real region of page(or container) which will be set for this tab control to the specified value.

This function is called when recalculation of the real region of page is necessary since the real region of this tab control is changed.

To reflect the value set with this function to all the pages of this tab control, call the SFYTabControl::AdjustPages function.

Reference

SFYTabControl::GetContentBound | SFYTabControl::AdjustPages

Description

This function sets the number of the tab pages which is displayed at the same time in this tab control to the specified value.

Default: 2

Reference

SFYTabControl::GetFieldValue

Description

This function sets the key with which the focus is moved to the page(or container) left next to the currently focused page(or container) of this tab control to the specified value.

Default: AVK_LEFT

Reference

SFYTabControl::GetFocusLeftKey | SFYTabControl::FocusLeft

Description

This function sets the key with which the focus is moved to the page(or container) right next to the currently focused page(or container) of this tab control to the specified value.

Default: AVK_RIGHT

Reference

SFYTabControl::GetFocusRightKey | SFYTabControl::FocusRight

Description

This function sets the background color of the safe page of this tab control to the specified value, which will be displayed when the specified page does not exist or is invalid.

Default: SFXRGBColor(0xFF, 0xFF, 0xFF, 0x00) [white color]

Reference

SFYTabControl::GetSafePageBackgroundColor

Return value

Description

This function sets the scroll bar control which is internally used by this tab control to the specified value.

Default: SFZScrollBarControl

Example

The code below is to switch the standard scroll bar control with the custom scroll bar.

// create instance of scroll bar control
USRScrollBar bar = USRScrollBar::NewInstance();

// set its state to "visible" + "active" + "disable" + "unfocus"
bar->SetState(true, true, false, false);

// set custom scroll bar control
_tab->SetScrollBarControl(bar);

Reference

SFYTabControl::GetScrollBarControl | SFZScrollBarControl

Description

This function sets the width of the scroll bar control to the specified value, which is internally used by this tab control. [pixels]

Default: 5 pixels

Reference

SFYTabControl::GetScrollBarWidth

Description

This function sets the tab-loop flag showing whether or not the focus at the first or last page can be moved to the last or first page respectively to the specified value.

If "true" is set, the focus at the first or last page can be moved to the last or first page respectively.

If "false" is set, the focus at the first or last page cannot be moved to the last or first page respectively.

Default: true

Reference

SFYTabControl::GetTabLoop

Reference

SFYResponder::GetType | SFYResponder::SetType