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