Do not #include an header where a forward declaration suffixes. Do not

[wxWidgets.git] / include / wx / motif / tabctrl.h

/////////////////////////////////////////////////////////////////////////////
// Name:        tabctrl.h
// Purpose:     wxTabCtrl class
// Author:      Julian Smart
// Modified by:
// Created:     17/09/98
// RCS-ID:      $Id$
// Copyright:   (c) Julian Smart
// Licence:   	wxWindows licence
/////////////////////////////////////////////////////////////////////////////

#ifndef _WX_TABCTRL_H_
#define _WX_TABCTRL_H_

#ifdef __GNUG__
#pragma interface "tabctrl.h"
#endif

class wxImageList;

/*
* Flags returned by HitTest
*/

#define wxTAB_HITTEST_NOWHERE           1
#define wxTAB_HITTEST_ONICON            2
#define wxTAB_HITTEST_ONLABEL           4
#define wxTAB_HITTEST_ONITEM            6

class WXDLLEXPORT wxTabCtrl: public wxControl
{
    DECLARE_DYNAMIC_CLASS(wxTabCtrl)
public:
/*
* Public interface
    */
    
    wxTabCtrl();
    
    inline wxTabCtrl(wxWindow *parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
        long style = 0, const wxString& name = "tabCtrl")
    {
        Create(parent, id, pos, size, style, name);
    }
    ~wxTabCtrl();
    
    // Accessors
    
    // Get the selection
    int GetSelection() const;
    
    // Get the tab with the current keyboard focus
    int GetCurFocus() const;
    
    // Get the associated image list
    wxImageList* GetImageList() const;
    
    // Get the number of items
    int GetItemCount() const;
    
    // Get the rect corresponding to the tab
    bool GetItemRect(int item, wxRect& rect) const;
    
    // Get the number of rows
    int GetRowCount() const;
    
    // Get the item text
    wxString GetItemText(int item) const ;
    
    // Get the item image
    int GetItemImage(int item) const;
    
    // Get the item data
    void* GetItemData(int item) const;
    
    // Set the selection
    int SetSelection(int item);
    
    // Set the image list
    void SetImageList(wxImageList* imageList);
    
    // Set the text for an item
    bool SetItemText(int item, const wxString& text);
    
    // Set the image for an item
    bool SetItemImage(int item, int image);
    
    // Set the data for an item
    bool SetItemData(int item, void* data);
    
    // Set the size for a fixed-width tab control
    void SetItemSize(const wxSize& size);
    
    // Set the padding between tabs
    void SetPadding(const wxSize& padding);
    
    // Operations
    
    bool Create(wxWindow *parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
        long style = 0, const wxString& name = "tabCtrl");
    
    // Delete all items
    bool DeleteAllItems();
    
    // Delete an item
    bool DeleteItem(int item);
    
    // Hit test
    int HitTest(const wxPoint& pt, long& flags);
    
    // Insert an item
    bool InsertItem(int item, const wxString& text, int imageId = -1, void* data = NULL);
    
    void Command(wxCommandEvent& event);
    
protected:
    wxImageList*    m_imageList;
    
    DECLARE_EVENT_TABLE()
};

class WXDLLEXPORT wxTabEvent: public wxCommandEvent
{
    DECLARE_DYNAMIC_CLASS(wxTabEvent)
        
public:
    wxTabEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
};

typedef void (wxEvtHandler::*wxTabEventFunction)(wxTabEvent&);

#define EVT_TAB_SEL_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY(wxEVT_COMMAND_TAB_SEL_CHANGED, \
id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTabEventFunction) & fn, NULL ),
#define EVT_TAB_SEL_CHANGING(id, fn) DECLARE_EVENT_TABLE_ENTRY(wxEVT_COMMAND_TAB_SEL_CHANGING, \
id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTabEventFunction) & fn, NULL ),

#endif
// _WX_TABCTRL_H_