src/richtext/richtextformatdlg.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/richtext/richtextformatdlg.cpp
   3 // Purpose:     Formatting dialog for wxRichTextCtrl
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     2006-10-01
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // For compilers that support precompilation, includes "wx.h".
  13 #include "wx/wxprec.h"
  14
  15 #ifdef __BORLANDC__
  16     #pragma hdrstop
  17 #endif
  18
  19 #if wxUSE_RICHTEXT
  20
  21 #include "wx/richtext/richtextformatdlg.h"
  22
  23 #ifndef WX_PRECOMP
  24     #include "wx/listbox.h"
  25     #include "wx/combobox.h"
  26     #include "wx/textctrl.h"
  27     #include "wx/sizer.h"
  28     #include "wx/stattext.h"
  29     #include "wx/statline.h"
  30     #include "wx/radiobut.h"
  31     #include "wx/icon.h"
  32     #include "wx/bitmap.h"
  33     #include "wx/dcclient.h"
  34     #include "wx/frame.h"
  35     #include "wx/checkbox.h"
  36     #include "wx/button.h"
  37 #endif // WX_PRECOMP
  38
  39 #include "wx/bookctrl.h"
  40 #include "wx/colordlg.h"
  41 #include "wx/fontenum.h"
  42 #include "wx/settings.h"
  43 #include "wx/module.h"
  44 #include "wx/imaglist.h"
  45
  46 #include "wx/richtext/richtextctrl.h"
  47 #include "wx/richtext/richtextstyles.h"
  48
  49 #include "richtextfontpage.cpp"
  50 #include "richtextindentspage.cpp"
  51 #include "richtexttabspage.cpp"
  52 #include "richtextbulletspage.cpp"
  53 #include "richtextstylepage.cpp"
  54
  55 #if 0 // def __WXMAC__
  56 #define wxRICHTEXT_USE_TOOLBOOK true
  57 #else
  58 #define wxRICHTEXT_USE_TOOLBOOK false
  59 #endif
  60
  61 IMPLEMENT_CLASS(wxRichTextFormattingDialog, wxPropertySheetDialog)
  62
  63 BEGIN_EVENT_TABLE(wxRichTextFormattingDialog, wxPropertySheetDialog)
  64     EVT_NOTEBOOK_PAGE_CHANGED(-1, wxRichTextFormattingDialog::OnTabChanged)
  65 END_EVENT_TABLE()
  66
  67 wxRichTextFormattingDialogFactory* wxRichTextFormattingDialog::ms_FormattingDialogFactory = NULL;
  68
  69 void wxRichTextFormattingDialog::Init()
  70 {
  71     m_imageList = NULL;
  72     m_styleDefinition = NULL;
  73     m_styleSheet = NULL;
  74 }
  75
  76 wxRichTextFormattingDialog::~wxRichTextFormattingDialog()
  77 {
  78     delete m_imageList;
  79     delete m_styleDefinition;
  80 }
  81
  82 bool wxRichTextFormattingDialog::Create(long flags, wxWindow* parent, const wxString& title, wxWindowID id,
  83         const wxPoint& pos, const wxSize& sz, long style)
  84 {
  85     SetExtraStyle(wxDIALOG_EX_CONTEXTHELP|wxWS_EX_VALIDATE_RECURSIVELY);
  86
  87     int resizeBorder = wxRESIZE_BORDER;
  88
  89     GetFormattingDialogFactory()->SetSheetStyle(this);
  90
  91     wxPropertySheetDialog::Create(parent, id, title, pos, sz,
  92         style | (int)wxPlatform::IfNot(wxOS_WINDOWS_CE, resizeBorder)
  93     );
  94
  95     GetFormattingDialogFactory()->CreateButtons(this);
  96     GetFormattingDialogFactory()->CreatePages(flags, this);
  97
  98     LayoutDialog();
  99
 100     return true;
 101 }
 102
 103 /// Get attributes from the given range
 104 bool wxRichTextFormattingDialog::GetStyle(wxRichTextCtrl* ctrl, const wxRichTextRange& range)
 105 {
 106     if (ctrl->GetBuffer().GetStyleForRange(range.ToInternal(), m_attributes))
 107         return UpdateDisplay();
 108     else
 109         return false;
 110 }
 111
 112 /// Apply attributes to the given range, only applying if necessary (wxRICHTEXT_SETSTYLE_OPTIMIZE)
 113 bool wxRichTextFormattingDialog::ApplyStyle(wxRichTextCtrl* ctrl, const wxRichTextRange& range, int flags)
 114 {
 115     return ctrl->SetStyleEx(range, m_attributes, flags);
 116 }
 117
 118 /// Set the attributes and optionally update the display
 119 bool wxRichTextFormattingDialog::SetStyle(const wxTextAttrEx& style, bool update)
 120 {
 121     m_attributes = style;
 122     if (update)
 123         UpdateDisplay();
 124     return true;
 125 }
 126
 127 /// Set the style definition and optionally update the display
 128 bool wxRichTextFormattingDialog::SetStyleDefinition(const wxRichTextStyleDefinition& styleDef, wxRichTextStyleSheet* sheet, bool update)
 129 {
 130     m_styleSheet = sheet;
 131
 132     if (m_styleDefinition)
 133         delete m_styleDefinition;
 134     m_styleDefinition = styleDef.Clone();
 135
 136     return SetStyle(m_styleDefinition->GetStyle(), update);
 137 }
 138
 139 /// Transfers the data and from to the window
 140 bool wxRichTextFormattingDialog::TransferDataToWindow()
 141 {
 142     if (m_styleDefinition)
 143         m_attributes = m_styleDefinition->GetStyle();
 144
 145     if (!wxPropertySheetDialog::TransferDataToWindow())
 146         return false;
 147
 148     return true;
 149 }
 150
 151 bool wxRichTextFormattingDialog::TransferDataFromWindow()
 152 {
 153     if (!wxPropertySheetDialog::TransferDataFromWindow())
 154         return false;
 155
 156     if (m_styleDefinition)
 157         m_styleDefinition->GetStyle() = m_attributes;
 158
 159     return true;
 160 }
 161
 162 /// Update the display
 163 bool wxRichTextFormattingDialog::UpdateDisplay()
 164 {
 165     return TransferDataToWindow();
 166 }
 167
 168 /// Apply the styles when a different tab is selected, so the previews are
 169 /// up to date
 170 void wxRichTextFormattingDialog::OnTabChanged(wxNotebookEvent& event)
 171 {
 172     if (GetBookCtrl() != event.GetEventObject())
 173     {
 174         event.Skip();
 175         return;
 176     }
 177
 178     int oldPageId = event.GetOldSelection();
 179     if (oldPageId != -1)
 180     {
 181         wxWindow* page = GetBookCtrl()->GetPage(oldPageId);
 182         if (page)
 183             page->TransferDataFromWindow();
 184     }
 185
 186     int pageId = event.GetSelection();
 187     if (pageId != -1)
 188     {
 189         wxWindow* page = GetBookCtrl()->GetPage(pageId);
 190         if (page)
 191             page->TransferDataToWindow();
 192     }
 193 }
 194
 195 void wxRichTextFormattingDialog::SetFormattingDialogFactory(wxRichTextFormattingDialogFactory* factory)
 196 {
 197     if (ms_FormattingDialogFactory)
 198         delete ms_FormattingDialogFactory;
 199     ms_FormattingDialogFactory = factory;
 200 }
 201
 202 /*!
 203  * Factory for formatting dialog
 204  */
 205
 206 /// Create all pages, under the dialog's book control, also calling AddPage
 207 bool wxRichTextFormattingDialogFactory::CreatePages(long pages, wxRichTextFormattingDialog* dialog)
 208 {
 209     if (dialog->GetImageList())
 210         dialog->GetBookCtrl()->SetImageList(dialog->GetImageList());
 211
 212     int availablePageCount = GetPageIdCount();
 213     int i;
 214     bool selected = false;
 215     for (i = 0; i < availablePageCount; i ++)
 216     {
 217         int pageId = GetPageId(i);
 218         if (pageId != -1 && (pages & pageId))
 219         {
 220             wxString title;
 221             wxPanel* panel = CreatePage(pageId, title, dialog);
 222             wxASSERT( panel != NULL );
 223             if (panel)
 224             {
 225                 int imageIndex = GetPageImage(pageId);
 226                 dialog->GetBookCtrl()->AddPage(panel, title, !selected, imageIndex);
 227                 selected = true;
 228             }
 229         }
 230     }
 231
 232     return true;
 233 }
 234
 235 /// Create a page, given a page identifier
 236 wxPanel* wxRichTextFormattingDialogFactory::CreatePage(int page, wxString& title, wxRichTextFormattingDialog* dialog)
 237 {
 238     if (page == wxRICHTEXT_FORMAT_STYLE_EDITOR)
 239     {
 240         wxRichTextStylePage* page = new wxRichTextStylePage(dialog->GetBookCtrl(), wxID_ANY);
 241         title = _("Style");
 242         return page;
 243     }
 244     else if (page == wxRICHTEXT_FORMAT_FONT)
 245     {
 246         wxRichTextFontPage* page = new wxRichTextFontPage(dialog->GetBookCtrl(), wxID_ANY);
 247         title = _("Font");
 248         return page;
 249     }
 250     else if (page == wxRICHTEXT_FORMAT_INDENTS_SPACING)
 251     {
 252         wxRichTextIndentsSpacingPage* page = new wxRichTextIndentsSpacingPage(dialog->GetBookCtrl(), wxID_ANY);
 253         title = _("Indents && Spacing");
 254         return page;
 255     }
 256     else if (page == wxRICHTEXT_FORMAT_TABS)
 257     {
 258         wxRichTextTabsPage* page = new wxRichTextTabsPage(dialog->GetBookCtrl(), wxID_ANY);
 259         title = _("Tabs");
 260         return page;
 261     }
 262     else if (page == wxRICHTEXT_FORMAT_BULLETS)
 263     {
 264         wxRichTextBulletsPage* page = new wxRichTextBulletsPage(dialog->GetBookCtrl(), wxID_ANY);
 265         title = _("Bullets");
 266         return page;
 267     }
 268     else
 269         return NULL;
 270 }
 271
 272 /// Enumerate all available page identifiers
 273 int wxRichTextFormattingDialogFactory::GetPageId(int i) const
 274 {
 275     int pages[] = {
 276         wxRICHTEXT_FORMAT_STYLE_EDITOR,
 277         wxRICHTEXT_FORMAT_FONT,
 278         wxRICHTEXT_FORMAT_INDENTS_SPACING,
 279         wxRICHTEXT_FORMAT_BULLETS,
 280         wxRICHTEXT_FORMAT_TABS };
 281
 282     if (i < 0 || i > 4)
 283         return -1;
 284
 285     return pages[i];
 286 }
 287
 288 /// Get the number of available page identifiers
 289 int wxRichTextFormattingDialogFactory::GetPageIdCount() const
 290 {
 291     return 5;
 292 }
 293
 294 /// Set the sheet style, called at the start of wxRichTextFormattingDialog::Create
 295 bool wxRichTextFormattingDialogFactory::SetSheetStyle(wxRichTextFormattingDialog* dialog)
 296 {
 297     bool useToolBook = wxRICHTEXT_USE_TOOLBOOK;
 298     if (useToolBook)
 299     {
 300         int sheetStyle = wxPROPSHEET_SHRINKTOFIT;
 301 #ifdef __WXMAC__
 302         sheetStyle |= wxPROPSHEET_BUTTONTOOLBOOK;
 303 #else
 304         sheetStyle |= wxPROPSHEET_TOOLBOOK;
 305 #endif
 306
 307         dialog->SetSheetStyle(sheetStyle);
 308         dialog->SetSheetInnerBorder(0);
 309         dialog->SetSheetOuterBorder(0);
 310     }
 311
 312     return true;
 313 }
 314
 315 /// Create the main dialog buttons
 316 bool wxRichTextFormattingDialogFactory::CreateButtons(wxRichTextFormattingDialog* dialog)
 317 {
 318     bool useToolBook = wxRICHTEXT_USE_TOOLBOOK;
 319
 320     // If using a toolbook, also follow Mac style and don't create buttons
 321     int flags = wxOK|wxCANCEL;
 322 #ifndef __WXWINCE__
 323     flags |= wxHELP;
 324 #endif
 325
 326     if (!useToolBook)
 327         dialog->CreateButtons(flags);
 328
 329     return true;
 330 }
 331
 332 /*
 333  * Module to initialise and clean up handlers
 334  */
 335
 336 class wxRichTextFormattingDialogModule: public wxModule
 337 {
 338 DECLARE_DYNAMIC_CLASS(wxRichTextFormattingDialogModule)
 339 public:
 340     wxRichTextFormattingDialogModule() {}
 341     bool OnInit() { wxRichTextFormattingDialog::SetFormattingDialogFactory(new wxRichTextFormattingDialogFactory); return true; };
 342     void OnExit() { wxRichTextFormattingDialog::SetFormattingDialogFactory(NULL); };
 343 };
 344
 345 IMPLEMENT_DYNAMIC_CLASS(wxRichTextFormattingDialogModule, wxModule)
 346
 347 /*
 348  * Font preview control
 349  */
 350
 351 BEGIN_EVENT_TABLE(wxRichTextFontPreviewCtrl, wxWindow)
 352     EVT_PAINT(wxRichTextFontPreviewCtrl::OnPaint)
 353 END_EVENT_TABLE()
 354
 355 void wxRichTextFontPreviewCtrl::OnPaint(wxPaintEvent& WXUNUSED(event))
 356 {
 357     wxPaintDC dc(this);
 358
 359     wxSize size = GetSize();
 360     wxFont font = GetFont();
 361
 362     if ( font.Ok() )
 363     {
 364         dc.SetFont(font);
 365         // Calculate vertical and horizontal centre
 366         long w = 0, h = 0;
 367
 368         wxString text(_("ABCDEFGabcdefg12345"));
 369
 370         dc.GetTextExtent( text, &w, &h);
 371         int cx = wxMax(2, (size.x/2) - (w/2));
 372         int cy = wxMax(2, (size.y/2) - (h/2));
 373
 374         dc.SetTextForeground(GetForegroundColour());
 375         dc.SetClippingRegion(2, 2, size.x-4, size.y-4);
 376         dc.DrawText(text, cx, cy);
 377         dc.DestroyClippingRegion();
 378     }
 379 }
 380
 381 // Helper for pages to get the top-level dialog
 382 wxRichTextFormattingDialog* wxRichTextFormattingDialog::GetDialog(wxWindow* win)
 383 {
 384     wxWindow* p = win->GetParent();
 385     while (p && !p->IsKindOf(CLASSINFO(wxRichTextFormattingDialog)))
 386         p = p->GetParent();
 387     wxRichTextFormattingDialog* dialog = wxDynamicCast(p, wxRichTextFormattingDialog);
 388     return dialog;
 389 }
 390
 391
 392 // Helper for pages to get the attributes
 393 wxTextAttrEx* wxRichTextFormattingDialog::GetDialogAttributes(wxWindow* win)
 394 {
 395     wxRichTextFormattingDialog* dialog = GetDialog(win);
 396     if (dialog)
 397         return & dialog->GetAttributes();
 398     else
 399         return NULL;
 400 }
 401
 402 // Helper for pages to get the style
 403 wxRichTextStyleDefinition* wxRichTextFormattingDialog::GetDialogStyleDefinition(wxWindow* win)
 404 {
 405     wxRichTextFormattingDialog* dialog = GetDialog(win);
 406     if (dialog)
 407         return dialog->GetStyleDefinition();
 408     else
 409         return NULL;
 410 }
 411
 412 /*
 413  * A control for displaying a small preview of a colour or bitmap
 414  */
 415
 416 BEGIN_EVENT_TABLE(wxRichTextColourSwatchCtrl, wxControl)
 417     EVT_MOUSE_EVENTS(wxRichTextColourSwatchCtrl::OnMouseEvent)
 418 END_EVENT_TABLE()
 419
 420 IMPLEMENT_CLASS(wxRichTextColourSwatchCtrl, wxControl)
 421
 422 wxRichTextColourSwatchCtrl::wxRichTextColourSwatchCtrl(wxWindow* parent, wxWindowID id, const wxPoint& pos, const wxSize& size, long style):
 423     wxControl(parent, id, pos, size, style)
 424 {
 425     SetColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
 426     SetBackgroundStyle(wxBG_STYLE_COLOUR);
 427 }
 428
 429 wxRichTextColourSwatchCtrl::~wxRichTextColourSwatchCtrl()
 430 {
 431 }
 432
 433 void wxRichTextColourSwatchCtrl::OnMouseEvent(wxMouseEvent& event)
 434 {
 435     if (event.LeftDown())
 436     {
 437         wxWindow* parent = GetParent();
 438         while (parent != NULL && !parent->IsKindOf(CLASSINFO(wxDialog)) && !parent->IsKindOf(CLASSINFO(wxFrame)))
 439             parent = parent->GetParent();
 440
 441         wxColourData data;
 442         data.SetChooseFull(true);
 443         data.SetColour(m_colour);
 444         wxColourDialog *dialog = new wxColourDialog(parent, &data);
 445         // Crashes on wxMac (no m_peer)
 446 #ifndef __WXMAC__
 447         dialog->SetTitle(_("Background colour"));
 448 #endif
 449         if (dialog->ShowModal() == wxID_OK)
 450         {
 451             wxColourData retData = dialog->GetColourData();
 452             m_colour = retData.GetColour();
 453             SetBackgroundColour(m_colour);
 454         }
 455         dialog->Destroy();
 456         Refresh();
 457
 458         wxCommandEvent event(wxEVT_COMMAND_BUTTON_CLICKED, GetId());
 459         GetEventHandler()->ProcessEvent(event);
 460     }
 461 }
 462
 463 #if wxUSE_HTML
 464
 465 /*!
 466  * wxRichTextFontListBox class declaration
 467  * A listbox to display styles.
 468  */
 469
 470 IMPLEMENT_CLASS(wxRichTextFontListBox, wxHtmlListBox)
 471
 472 BEGIN_EVENT_TABLE(wxRichTextFontListBox, wxHtmlListBox)
 473 END_EVENT_TABLE()
 474
 475 wxRichTextFontListBox::wxRichTextFontListBox(wxWindow* parent, wxWindowID id, const wxPoint& pos,
 476     const wxSize& size, long style)
 477 {
 478     Init();
 479     Create(parent, id, pos, size, style);
 480 }
 481
 482 bool wxRichTextFontListBox::Create(wxWindow* parent, wxWindowID id, const wxPoint& pos,
 483         const wxSize& size, long style)
 484 {
 485     return wxHtmlListBox::Create(parent, id, pos, size, style);
 486 }
 487
 488 wxRichTextFontListBox::~wxRichTextFontListBox()
 489 {
 490 }
 491
 492 /// Returns the HTML for this item
 493 wxString wxRichTextFontListBox::OnGetItem(size_t n) const
 494 {
 495     if (m_faceNames.GetCount() == 0)
 496         return wxEmptyString;
 497
 498     wxString str = CreateHTML(m_faceNames[n]);
 499     return str;
 500 }
 501
 502 /// Get font name for index
 503 wxString wxRichTextFontListBox::GetFaceName(size_t i) const
 504 {
 505     return m_faceNames[i];
 506 }
 507
 508 /// Set selection for string, returning the index.
 509 int wxRichTextFontListBox::SetFaceNameSelection(const wxString& name)
 510 {
 511     int i = m_faceNames.Index(name);
 512     SetSelection(i);
 513
 514     return i;
 515 }
 516
 517 /// Updates the font list
 518 void wxRichTextFontListBox::UpdateFonts()
 519 {
 520     wxFontEnumerator enumerator;
 521     enumerator.EnumerateFacenames();
 522     wxArrayString facenames = enumerator.GetFacenames();
 523     m_faceNames = facenames;
 524     m_faceNames.Sort();
 525
 526     SetItemCount(m_faceNames.GetCount());
 527     Refresh();
 528 }
 529
 530 #if 0
 531 // Convert a colour to a 6-digit hex string
 532 static wxString ColourToHexString(const wxColour& col)
 533 {
 534     wxString hex;
 535
 536     hex += wxDecToHex(col.Red());
 537     hex += wxDecToHex(col.Green());
 538     hex += wxDecToHex(col.Blue());
 539
 540     return hex;
 541 }
 542 #endif
 543
 544 /// Creates a suitable HTML fragment for a definition
 545 wxString wxRichTextFontListBox::CreateHTML(const wxString& facename) const
 546 {
 547     wxString str = wxT("<font");
 548
 549     str << wxT(" size=\"+2\"");;
 550
 551     if (!facename.IsEmpty() && facename != _("(none)"))
 552         str << wxT(" face=\"") << facename << wxT("\"");
 553 /*
 554     if (def->GetStyle().GetTextColour().Ok())
 555         str << wxT(" color=\"#") << ColourToHexString(def->GetStyle().GetTextColour()) << wxT("\"");
 556 */
 557
 558     str << wxT(">");
 559
 560     bool hasBold = false;
 561
 562     if (hasBold)
 563         str << wxT("<b>");
 564
 565     str += facename;
 566
 567     if (hasBold)
 568         str << wxT("</b>");
 569
 570     str << wxT("</font>");
 571
 572     return str;
 573 }
 574
 575 #endif
 576     // wxUSE_HTML
 577
 578
 579 #endif
 580     // wxUSE_RICHTEXT
 581