Modify doxygen sample code
authorChoongeun Hong <cheun.hong@samsung.com>
Thu, 9 May 2013 13:07:41 +0000 (22:07 +0900)
committerChoongeun Hong <cheun.hong@samsung.com>
Thu, 9 May 2013 13:07:41 +0000 (22:07 +0900)
Change-Id: I4d9743efcb3ed48ddc0e688916705afe0773ab5f
Signed-off-by: Choongeun Hong <cheun.hong@samsung.com>
13 files changed:
inc/FUiCardLayout.h
inc/FUiCtrlColorPicker.h
inc/FUiCtrlCustomList.h
inc/FUiCtrlEditArea.h
inc/FUiCtrlExpandableEditArea.h
inc/FUiCtrlExpandableList.h
inc/FUiCtrlGroupedList.h
inc/FUiCtrlGroupedTableView.h
inc/FUiCtrlList.h
inc/FUiCtrlMessageBox.h
inc/FUiCtrlOverlayRegion.h
inc/FUiCtrlScrollPanel.h
inc/FUiHorizontalBoxLayout.h

index 4a35d8d..3c5fe4e 100644 (file)
@@ -55,6 +55,7 @@ public:
  *     @code
 // Sample code for CardLayoutSample.cpp
 #include <FGraphics.h>
+#include <FUiCardLayout.h>
 
 #include "CardLayoutSample.h"
 
@@ -77,7 +78,7 @@ CardLayoutSample::Initialize(void)
 result
 CardLayoutSample::OnInitializing(void)
 {
-       result = E_SUCCESS;
+       result = E_SUCCESS;
 
        // Creates an instance of 1st panel
        Panel* pFirstPanel = new Panel();
@@ -85,7 +86,7 @@ CardLayoutSample::OnInitializing(void)
        pFirstPanel->SetBackgroundColor(Color(0xFF, 0x40, 0x40, 0xFF));
 
        // Adds the 1st panel to the form
-       AddControl(*pFirstPanel);
+       AddControl(pFirstPanel);
 
        // Creates an instance of 2nd panel
        Panel* pSecondPanel = new Panel();
@@ -93,7 +94,7 @@ CardLayoutSample::OnInitializing(void)
        pSecondPanel->SetBackgroundColor(Color(0x40, 0x40, 0xFF, 0xFF));
 
        // Adds the 2nd panel to the form
-       AddControl(*pSecondPanel);
+       AddControl(pSecondPanel);
 
        return r;
 }
index 935d4ad..6c7770e 100644 (file)
@@ -94,7 +94,7 @@ ColorPickerSample::OnInitializing(void)
        __pColorPicker->AddColorChangeEventListener(*this);
 
        // Adds the color picker to the form
-       AddControl(*__pColorPicker);
+       AddControl(__pColorPicker);
 
        return r;
 }
index f2ff373..ab9ca49 100644 (file)
@@ -193,7 +193,7 @@ CustomListSample::OnInitializing(void)
        }
 
        // Adds the custom list to the form
-       AddControl(*__pCustomList);
+       AddControl(__pCustomList);
 
        // Deallocates bitmaps
        delete pBitmapNormal;
index db87e2f..424e69d 100644 (file)
@@ -117,7 +117,7 @@ EditAreaSample::OnInitializing(void)
        __pEditArea->AddTextEventListener(*this);
 
        // Adds the edit area to the form
-       AddControl(*__pEditArea);
+       AddControl(__pEditArea);
 
        return r;
 }
index 8a349eb..165a29a 100644 (file)
@@ -165,7 +165,7 @@ ExpandableEditAreaSample::OnInitializing(void)
        __pExpandableEdit->AddKeypadEventListener(*this);
        __pExpandableEdit->AddExpandableEditAreaEventListener(*this);
 
-       AddControl(*__pExpandableEdit);
+       AddControl(__pExpandableEdit);
 
        // Sets a focus to the expandable edit area
        __pExpandableEdit->SetFocus();
index 08d96c3..3f28c2b 100644 (file)
@@ -162,7 +162,7 @@ ExpandableListSample::OnInitializing(void)
        AddListSubItem(*pExpandableList, ID_LIST_MAINITEM, L"SubItem");
 
        // Adds the expandable list to the form
-       AddControl(*pExpandableList);
+       AddControl(pExpandableList);
 
        // Deallocates bitmaps
        delete pBitmapNormal;
index 9066b2a..1b7b546 100644 (file)
@@ -163,7 +163,7 @@ GroupedListSample::OnInitializing(void)
        }
 
        // Adds the grouped list to the form
-       AddControl(*__pGroupedList);
+       AddControl(__pGroupedList);
 
        // Deallocates bitmaps
        delete pBitmapNormal;
index 8a5bbfb..62b2049 100644 (file)
@@ -124,14 +124,14 @@ GroupedTableViewSample::OnInitializing(void)
        // Creates an instance of TableView
        __pGroupedTableView = new GroupedTableView();
        __pGroupedTableView->Construct(Rectangle(0, 0, GetClientAreaBounds().width, GetClientAreaBounds().height), true, TABLE_VIEW_SCROLL_BAR_STYLE_FAST_SCROLL);
-       __pGroupedTableView->SetItemProvider(*this);
+       __pGroupedTableView->SetItemProvider(this);
        __pGroupedTableView->AddGroupedTableViewItemEventListener(*this);
 
        __pGroupedTableView->AddFastScrollListener(*this);
        __pGroupedTableView->SetFastScrollIndex(L"ABCDEFGHIJKLMNOPQRSTUVWXYZ", true);
 
        // Adds the TableView to the form
-       AddControl(*__pGroupedTableView);
+       AddControl(__pGroupedTableView);
 
        // Creates an instance of TableViewContextItem
        __pContextItem = new TableViewContextItem();
@@ -143,8 +143,8 @@ GroupedTableViewSample::OnInitializing(void)
        Button* pButton2 = new Button();
        pButton2->Construct(Rectangle(250, 10, 200, 80), L"Context2");
 
-       __pContextItem->AddControl(*pButton);
-       __pContextItem->AddControl(*pButton2);
+       __pContextItem->AddControl(pButton);
+       __pContextItem->AddControl(pButton2);
 
        return r;
 }
@@ -155,8 +155,8 @@ GroupedTableViewSample::OnTerminating(void)
        result r = E_SUCCESS;
 
        // Deallocates the item context
-       delete __pItemContext;
-       __pItemContext = null;
+       delete __pContextItem;
+       __pContextItem = null;
 
        return r;
 }
@@ -229,9 +229,9 @@ GroupedTableViewSample::CreateGroupItem(int groupIndex, int itemWidth)
        text.Format(30, L"Group title %d", groupIndex);
 
        Label* pLabel = new Label();
-       pLabel->Construct(Rectangle(0, 0, itemWidth, GetDefaultGroupItemHeight(), text);
+       pLabel->Construct(Rectangle(0, 0, itemWidth, GetDefaultGroupItemHeight()), text);
 
-       pItem->AddControl(*pLable);
+       pItem->AddControl(pLabel);
 
        return pItem;
 }
@@ -286,16 +286,16 @@ GroupedTableViewSample::CreateItem(int groupIndex, int itemIndex, int itemWidth)
        text.Format(30, L"TableViewItem %d", itemIndex);
 
        Label* pLabel = new Label();
-       pLabel->Construct(Rectangle(0, 0, itemWidth, GetDefaultItemHeight(), text);
+       pLabel->Construct(Rectangle(0, 0, itemWidth, GetDefaultItemHeight()), text);
 
-       pItem->AddControl(*pLabel);
+       pItem->AddControl(pLabel);
        pItem->SetContextItem(__pContextItem);
 
        return pItem;
 }
 
 bool
-GroupedTableViewSample::DeleteItem(int groupIndex, int itemIndex, Controls::TableViewItem* pItem)
+GroupedTableViewSample::DeleteItem(int groupIndex, int itemIndex, TableViewItem* pItem)
 {
        pItem->Destroy();
 
@@ -303,7 +303,7 @@ GroupedTableViewSample::DeleteItem(int groupIndex, int itemIndex, Controls::Tabl
 }
 
 void
-GroupedTableViewSample::UpdateItem(int groupIndex, int itemIndex, Controls::TableViewItem* pItem)
+GroupedTableViewSample::UpdateItem(int groupIndex, int itemIndex, TableViewItem* pItem)
 {
        // ....
 }
index 13ecf40..787cb6b 100644 (file)
@@ -143,7 +143,7 @@ ListSample::OnInitializing(void)
        __pList->AddItem(&itemText2, null, null, null, ID_LIST_SECONDITEM);
 
        // Adds the list to the form
-       AddControl(*__pList);
+       AddControl(__pList);
 
        return r;
 }
index 1599584..e51440f 100644 (file)
@@ -136,7 +136,7 @@ MessageBoxSample::OnInitializing(void)
        pButton->AddActionEventListener(*this);
 
        // Adds the button to the form
-       AddControl(*pButton);
+       AddControl(pButton);
 
        return r;
 }
index e0f8926..0b69a23 100644 (file)
@@ -210,11 +210,11 @@ OverlayRegionSampleForm::OnInitializing(void)
        Label* pLabel = new Label();
        pLabel->Construct(Rectangle(positionX, positionY, 400, 80),L"OverlayRegion Sample");
        pLabel->SetTextColor(Color::GetColor(COLOR_ID_RED));
-       AddControl(*pLabel);
+       AddControl(pLabel);
 
        Button* pButton = new Button();
        pButton->Construct(Rectangle(positionX + widthVideo - 200, positionX + HeightVideo - 100, 180, 80),L"BUTTON");
-       AddControl(*pButton);
+       AddControl(pButton);
 
        return r;
 }
index 01477d9..c288037 100644 (file)
@@ -102,11 +102,11 @@ ScrollPanelSample::OnInitializing(void)
        pEdit->SetText(L"Edit");
 
        // Adds the button and the edit field to the ScrollPanel
-       __pScrollPanel->AddControl(*pButton);
-       __pScrollPanel->AddControl(*pEdit);
+       __pScrollPanel->AddControl(pButton);
+       __pScrollPanel->AddControl(pEdit);
 
        // Adds the ScrollPanel to the form
-       AddControl(*__pScrollPanel);
+       AddControl(__pScrollPanel);
 
        return r;
 }
index 2efcfde..793480b 100644 (file)
@@ -94,24 +94,24 @@ HorizontalBoxLayoutSample::OnInitializing(void)
                pLabel1->Construct(Rectangle(0,0,GetClientAreaBounds().width/4,100), L"TOP");
                pLabel1->SetTextConfig(20, LABEL_TEXT_STYLE_NORMAL);
                pLabel1->SetBackgroundColor(Color(0x00, 0x10, 0x80, 0xFF));
-               pTopPanel->AddControl(*pLabel1);
+               pTopPanel->AddControl(pLabel1);
 
                Label* pLabel2 = new Label();
                pLabel2->Construct(Rectangle(0,0,GetClientAreaBounds().width/4,100), L"MIDDLE");
                pLabel2->SetTextConfig(20, LABEL_TEXT_STYLE_NORMAL);
                pLabel2->SetBackgroundColor(Color(0x00, 0x20, 0xA0, 0xFF));
-               pTopPanel->AddControl(*pLabel2);
+               pTopPanel->AddControl(pLabel2);
 
                Label* pLabel3 = new Label();
                pLabel3->Construct(Rectangle(0,0,GetClientAreaBounds().width/4,100), L"BOTTOM");
                pLabel3->SetTextConfig(20, LABEL_TEXT_STYLE_NORMAL);
                pLabel3->SetBackgroundColor(Color(0x00, 0x30, 0xC0, 0xFF));
-               pTopPanel->AddControl(*pLabel3);
+               pTopPanel->AddControl(pLabel3);
 
                Button* pButton = new Button();
                pButton->Construct(Rectangle(0,0,GetClientAreaBounds().width/4 - 10,100), L"FIT\nTO\nPARENT");
                pButton->SetTextSize(20);
-               pTopPanel->AddControl(*pButton);
+               pTopPanel->AddControl(pButton);
 
                // Sets relations each label and button
                topPanelLayout.SetVerticalAlignment(*pLabel1, LAYOUT_VERTICAL_ALIGN_TOP);
@@ -121,7 +121,7 @@ HorizontalBoxLayoutSample::OnInitializing(void)
                topPanelLayout.SetVerticalFitPolicy(*pButton, FIT_POLICY_PARENT);
        }
        // Adds the top panel to the form
-       AddControl(*pTopPanel);
+       AddControl(pTopPanel);
 
        // Creates an instance of HorizontalBoxLayout for bottom panel
        HorizontalBoxLayout bottomPanelLayout;
@@ -135,17 +135,17 @@ HorizontalBoxLayoutSample::OnInitializing(void)
                Label* pLabel1 = new Label();
                pLabel1->Construct(Rectangle(0,0,30,100), L"W\n1.0f");
                pLabel1->SetBackgroundColor(Color(0x00, 0x10, 0x80, 0xFF));
-               pBottomPanel->AddControl(*pLabel1);
+               pBottomPanel->AddControl(pLabel1);
 
                Label* pLabel2 = new Label();
                pLabel2->Construct(Rectangle(0,0,30,100), L"W\n2.0f");
                pLabel2->SetBackgroundColor(Color(0x00, 0x20, 0xA0, 0xFF));
-               pBottomPanel->AddControl(*pLabel2);
+               pBottomPanel->AddControl(pLabel2);
 
                Label* pLabel3 = new Label();
                pLabel3->Construct(Rectangle(0,0,30,100), L"W\n3.0f");
                pLabel3->SetBackgroundColor(Color(0x00, 0x30, 0xC0, 0xFF));
-               pBottomPanel->AddControl(*pLabel3);
+               pBottomPanel->AddControl(pLabel3);
 
                // Sets relations each label
                bottomPanelLayout.SetVerticalFitPolicy(*pLabel1, FIT_POLICY_PARENT);
@@ -157,7 +157,7 @@ HorizontalBoxLayoutSample::OnInitializing(void)
        }
 
        // Adds the bottom panel to the form
-       AddControl(*pBottomPanel);
+       AddControl(pBottomPanel);
 
        //Gets the layout of the form
        VerticalBoxLayout* pFormLayout = dynamic_cast<VerticalBoxLayout*>(this->GetLayoutN());