×
Namespaces

Variants
Actions
(Difference between revisions)

Constructing a Symbian container control

From Nokia Developer Wiki
Jump to: navigation, search
Forum Nokia KB (Talk | contribs)
m (Protected "CS000861 - Custom control: Container control" [edit=sysop:move=sysop])
Forum Nokia KB (Talk | contribs)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
__NOEDITSECTION__
 
__NOEDITSECTION__
 
+
{{KBCS}}
 
{|style="background:#eceff2" width="660px" border="1" cellpadding="5" cellspacing="0"  
 
{|style="background:#eceff2" width="660px" border="1" cellpadding="5" cellspacing="0"  
 
|-
 
|-
|'''ID''' ||  
+
|'''ID''' || CS000861
|'''Creation date''' || March 7, 2008
+
|'''Creation date''' || March 25, 2008
 
|-
 
|-
|'''Platform''' || S60 3rd Edition
+
|'''Platform''' || S60 3rd Edition, FP1
 
|'''Tested on devices''' || Nokia N95
 
|'''Tested on devices''' || Nokia N95
 
|-
 
|-
Line 22: Line 22:
  
 
==Overview==
 
==Overview==
This code snippet shows how to create container control that
 
owns custom controls. Example shows how to focus the first component
 
with rectangle. Later we show how to change focus.
 
  
Example extends the existing code snippet [[Custom_control]].
+
This code snippet shows how to create a container control that
 +
owns custom controls. The example shows how to focus the first component
 +
with a rectangle and how to change focus.
  
Container controls stores its controls into <tt>CCoeControlArray</tt>.
+
The example extends the existing code snippet [[CS000859 - Custom control]].
 +
 
 +
Container controls store their controls into <tt>CCoeControlArray</tt>.
  
 
==Header==
 
==Header==
Line 102: Line 103:
 
     TPoint position;
 
     TPoint position;
  
     // Goes throught all components of this container controls
+
     // Goes through all components of this container control
 
     CCoeControlArray::TCursor cursor = Components().Begin();
 
     CCoeControlArray::TCursor cursor = Components().Begin();
 
     CCoeControl* ctrl = NULL;
 
     CCoeControl* ctrl = NULL;
 
     while ((ctrl = cursor.Control<CCoeControl>()) != NULL)
 
     while ((ctrl = cursor.Control<CCoeControl>()) != NULL)
 
         {
 
         {
         // If control is not visible does not handle it
+
         // If control is not visible, it does not handle it
 
         if (!ctrl->IsVisible())
 
         if (!ctrl->IsVisible())
 
             {
 
             {
Line 159: Line 160:
 
         }
 
         }
  
     // Update controls position
+
     // Update control's position
 
     UpdateControls();
 
     UpdateControls();
 
     }
 
     }
Line 165: Line 166:
  
 
==SizeChanged==
 
==SizeChanged==
When <tt>CMyContainerControl</tt> size changes (when e.g. SetRect() is called) have
+
When <tt>CMyContainerControl</tt>'s size changes (when, for example, SetRect() is called), components' positions have to be calculated again.
to components positions calculated again.
+
 
 
<code cpp>
 
<code cpp>
 
void CMyContainerControl::SizeChanged()
 
void CMyContainerControl::SizeChanged()
Line 176: Line 177:
  
 
==Focusing component==
 
==Focusing component==
Folowing changes to <tt>CMyControl</tt> component.
+
 
* CMyControl::Draw() must call <tt>DrawFocusFrame()</tt> for drawing focus rectangle
+
Make the following changes to the <tt>CMyControl</tt> component.
* CMyControl::DrawFocusFrame() is new method where focus rectangle is drawed
+
* <tt>CMyControl::Draw()</tt> must call <tt>DrawFocusFrame()</tt> for drawing the focus rectangle
 +
* <tt>CMyControl::DrawFocusFrame()</tt> is a new method where focus rectangle is drawn
 
<code cpp>
 
<code cpp>
 
void CMyControl::Draw(const TRect& aRect) const
 
void CMyControl::Draw(const TRect& aRect) const
Line 213: Line 215:
 
==See also==
 
==See also==
 
Custom Control Series:
 
Custom Control Series:
* [[Custom_control]] How to define custom control
+
* [[CS000859 - Custom_control]] Defining a custom control  
* [[Custom_control_-_Construct_from_resource]] How to create control from resource
+
* [[CS000860 - Custom control: Construct from resource]] Creating a control from a resource
* [[Custom_control_-_container_control]] How to create container control
+
* [[Custom control - focusing]] Handling key events and changing active custom control focus
* [[Custom_control_-_focusing]] How to handle key events and change active custom control focus
+
* [[Custom control - scrollbars]] Adding scroll bar to custom control
* [[Custom_control_-_scrollbars]] How to add scroll bar into custom control
+
* [[Custom control - in dialog]] Adding a custom control into CAknDialog
* [[Custom_control_-_in_dialog]] How to add custom control into CAknDialog
+
 
* [[Image:CustomControl.zip]] Example code patch
 
* [[Image:CustomControl.zip]] Example code patch
  
 
[[Category:Symbian C++]][[Category:UI]][[Category:S60]][[Category:Code Examples]]
 
[[Category:Symbian C++]][[Category:UI]][[Category:S60]][[Category:Code Examples]]

Revision as of 13:35, 25 March 2008


Template:KBCS

ID CS000861 Creation date March 25, 2008
Platform S60 3rd Edition, FP1 Tested on devices Nokia N95
Category Symbian C++ Subcategory UI


Keywords (APIs, classes, methods, functions): CCoeControl, TResourceReader, CCoeControlArray

Overview

This code snippet shows how to create a container control that owns custom controls. The example shows how to focus the first component with a rectangle and how to change focus.

The example extends the existing code snippet CS000859 - Custom control.

Container controls store their controls into CCoeControlArray.

Header

class CMyContainerControl : public CCoeControl
{
public:
static CMyContainerControl* NewL(const TRect& aRect);
static CMyContainerControl* NewLC(const TRect& aRect);
virtual ~CMyContainerControl();
 
private: // from CCoeControl
void Draw(const TRect& aRect) const;
void SizeChanged();
 
public: // own methods
// NOTE: Transfer ownership to CMyContainerControl
void AddControlL(CCoeControl* aControl,TInt aControlId);
void UpdateControls();
 
private: // own methods
CMyContainerControl();
void ConstructL(const TRect& aRect);
};


Source

CMyContainerControl* CMyContainerControl::NewL(const TRect& aRect)
{
CMyContainerControl* self = CMyContainerControl::NewLC(aRect);
CleanupStack::Pop(self);
return self;
}
 
CMyContainerControl* CMyContainerControl::NewLC(const TRect& aRect)
{
CMyContainerControl* self = new(ELeave) CMyContainerControl();
CleanupStack::PushL(self);
self->ConstructL(aRect);
return self;
}
 
CMyContainerControl::CMyContainerControl()
{
}
 
CMyContainerControl::~CMyContainerControl()
{
}
 
void CMyContainerControl::ConstructL(const TRect& aRect)
{
// No parent owner, so create an own window
CreateWindowL();
 
// Initialize component array
InitComponentArrayL();
 
SetRect(aRect);
 
ActivateL();
}
 
void CMyContainerControl::SizeChanged()
{
UpdateControls();
}
 
void CMyContainerControl::UpdateControls()
{
TPoint position;
 
// Goes through all components of this container control
CCoeControlArray::TCursor cursor = Components().Begin();
CCoeControl* ctrl = NULL;
while ((ctrl = cursor.Control<CCoeControl>()) != NULL)
{
// If control is not visible, it does not handle it
if (!ctrl->IsVisible())
{
cursor.Next();
continue;
}
 
// Set position
ctrl->SetPosition(position);
 
// Set size
TSize size = ctrl->MinimumSize();
size.SetSize(Rect().Width(),size.iHeight);
ctrl->SetSize(size);
 
// Visible?
if (position.iY >= Rect().iBr.iY)
{
ctrl->MakeVisible(EFalse);
}
else
{
ctrl->MakeVisible(ETrue);
}
 
// Store position of last component
position.iY += size.iHeight;
 
cursor.Next();
}
}
 
void CMyContainerControl::Draw(const TRect& /*aRect*/) const
{
CWindowGc& gc = SystemGc();
gc.SetBrushColor(KRgbBlack);
gc.Clear(Rect());
}
 
void CMyContainerControl::AddControlL(CCoeControl* aControl,TInt aControlId)
{
// NOTE: Transfer ownership of CCoeControl to CMyContainerControl
// Add control into container control
Components().AppendLC(aControl,aControlId);
CleanupStack::Pop(aControl);
 
// Focus first component
if (Components().Count()==1)
{
aControl->SetFocus(ETrue);
}
 
// Update control's position
UpdateControls();
}

SizeChanged

When CMyContainerControl's size changes (when, for example, SetRect() is called), components' positions have to be calculated again.

void CMyContainerControl::SizeChanged()
{
// Sets new position of the components
UpdateControls();
}

Focusing component

Make the following changes to the CMyControl component.

  • CMyControl::Draw() must call DrawFocusFrame() for drawing the focus rectangle
  • CMyControl::DrawFocusFrame() is a new method where focus rectangle is drawn
void CMyControl::Draw(const TRect& aRect) const
{
CWindowGc& gc = SystemGc();
gc.SetBrushColor(KRgbBlue);
gc.Clear(Rect());
 
DrawFocusFrame(aRect);
}
 
void CMyControl::DrawFocusFrame(const TRect& aRect) const
{
// Nothing to draw if not focused
if ( IsFocused() == EFalse )
return;
 
// Prep for draw
CWindowGc& gc = SystemGc();
gc.SetPenStyle( CGraphicsContext::ESolidPen );
gc.SetPenSize( TSize(KFocusFrameWidth,KFocusFrameWidth) );
gc.SetBrushStyle( CGraphicsContext::ENullBrush );
gc.SetPenColor( KRgbDarkGray );
 
// Draw the rounded rectangle
gc.DrawRoundRect( aRect, TSize( KFrameRoundRadius, KFrameRoundRadius ) );
}

Postconditions

CMyContainerControl container has some CMyControlcustom controls in a list.

See also

Custom Control Series:

160 page views in the last 30 days.

Was this page helpful?

Your feedback about this content is important. Let us know what you think.

 

Thank you!

We appreciate your feedback.

×