Split up the context menu functionality to make it easier to customise.

[wxWidgets.git] / include / wx / commandlinkbutton.h

/////////////////////////////////////////////////////////////////////////////
// Name:        wx/commandlinkbutton.h
// Purpose:     wxCommandLinkButtonBase and wxGenericCommandLinkButton classes
// Author:      Rickard Westerlund
// Created:     2010-06-11
// RCS-ID:      $Id$
// Copyright:   (c) 2010 wxWidgets team
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

#ifndef _WX_COMMANDLINKBUTTON_H_
#define _WX_COMMANDLINKBUTTON_H_

#include "wx/defs.h"

#if wxUSE_COMMANDLINKBUTTON

#include "wx/button.h"

// ----------------------------------------------------------------------------
// Command link button common base class
// ----------------------------------------------------------------------------

// This class has separate "main label" (title-like string) and (possibly
// multiline) "note" which can be set and queried separately but can also be
// set both at once by joining them with a new line and setting them as a
// label and queried by breaking the label into the parts before the first new
// line and after it.

class WXDLLIMPEXP_ADV wxCommandLinkButtonBase : public wxButton
{
public:
    wxCommandLinkButtonBase() : wxButton() { }

    wxCommandLinkButtonBase(wxWindow *parent,
                            wxWindowID id,
                            const wxString& mainLabel = wxEmptyString,
                            const wxString& note = wxEmptyString,
                            const wxPoint& pos = wxDefaultPosition,
                            const wxSize& size = wxDefaultSize,
                            long style = 0,
                            const wxValidator& validator =
                                wxDefaultValidator,
                            const wxString& name = wxButtonNameStr)
        : wxButton(parent,
                   id,
                   mainLabel + '\n' + note,
                   pos,
                   size,
                   style,
                   validator,
                   name)
        { }

    virtual void SetMainLabelAndNote(const wxString& mainLabel,
                                     const wxString& note) = 0;

    virtual void SetMainLabel(const wxString& mainLabel)
    {
        SetMainLabelAndNote(mainLabel, GetNote());
    }

    virtual void SetNote(const wxString& note)
    {
        SetMainLabelAndNote(GetMainLabel(), note);
    }

    virtual wxString GetMainLabel() const
    {
        return GetLabel().BeforeFirst('\n');
    }

    virtual wxString GetNote() const
    {
        return GetLabel().AfterFirst('\n');
    }

protected:
    virtual bool HasNativeBitmap() const { return false; }

private:
    wxDECLARE_NO_COPY_CLASS(wxCommandLinkButtonBase);
};

// ----------------------------------------------------------------------------
// Generic command link button
// ----------------------------------------------------------------------------

// Trivial generic implementation simply using a multiline label to show both
// the main label and the note.

class WXDLLIMPEXP_ADV wxGenericCommandLinkButton
                      : public wxCommandLinkButtonBase
{
public:
    wxGenericCommandLinkButton() : wxCommandLinkButtonBase() { }


    wxGenericCommandLinkButton(wxWindow *parent,
                               wxWindowID id,
                               const wxString& mainLabel = wxEmptyString,
                               const wxString& note = wxEmptyString,
                               const wxPoint& pos = wxDefaultPosition,
                               const wxSize& size = wxDefaultSize,
                               long style = 0,
                               const wxValidator& validator = wxDefaultValidator,
                               const wxString& name = wxButtonNameStr)
        : wxCommandLinkButtonBase()
    {
        Create(parent, id, mainLabel, note, pos, size, style, validator, name);
    }

    bool Create(wxWindow *parent,
                wxWindowID id,
                const wxString& mainLabel = wxEmptyString,
                const wxString& note = wxEmptyString,
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = 0,
                const wxValidator& validator = wxDefaultValidator,
                const wxString& name = wxButtonNameStr);

    virtual void SetMainLabelAndNote(const wxString& mainLabel,
                                     const wxString& note)
    {
        wxButton::SetLabel(mainLabel + '\n' + note);
    }

private:
    void SetDefaultBitmap();

    wxDECLARE_NO_COPY_CLASS(wxGenericCommandLinkButton);
};

#if defined(__WXMSW__) && !defined(__WXUNIVERSAL__)
    #include "wx/msw/commandlinkbutton.h"
#else
    class WXDLLIMPEXP_ADV wxCommandLinkButton : public wxGenericCommandLinkButton
    {
    public:
        wxCommandLinkButton() : wxGenericCommandLinkButton() { }

        wxCommandLinkButton(wxWindow *parent,
                            wxWindowID id,
                            const wxString& mainLabel = wxEmptyString,
                            const wxString& note = wxEmptyString,
                            const wxPoint& pos = wxDefaultPosition,
                            const wxSize& size = wxDefaultSize,
                            long style = 0,
                            const wxValidator& validator = wxDefaultValidator,
                            const wxString& name = wxButtonNameStr)
            : wxGenericCommandLinkButton(parent,
                                         id,
                                         mainLabel,
                                         note,
                                         pos,
                                         size,
                                         style,
                                         validator,
                                         name)
            { }

    private:
        wxDECLARE_DYNAMIC_CLASS_NO_COPY(wxCommandLinkButton);
    };
#endif // __WXMSW__/!__WXMSW__

#endif // wxUSE_COMMANDLINKBUTTON

#endif // _WX_COMMANDLINKBUTTON_H_