Table of Contents

wxHtmlWindow

include file: wxHtml.e


Note that this file also includes wxFile.e and wxGraphics.e.

Creation parameters:

This class can be used to display HTML documents. It does not always handle badly formed html very well. Make sure that any lists are surrounded by <ul> </ul> or <ol> </ol> tags.

  • func get_html_anchor( atom html_win )   
  • func get_html_page( atom html_win )   
  • proc get_html_page_title( atom html_win )   
  • proc get_html_page_title( atom html_win )   
  • proc html_append( atom htmlwin, sequence source)   
  • proc html_back( atom htmlwin )   
  • proc html_forward( atom htmlwin )   
  • proc load_html_file( atom htmlwin, sequence file)   
  • proc load_html_page( atom htmlwin, sequence page )   
  • proc set_html_page( atom htmlwin, sequence source )   
  • proc set_link_event( atom html_win, integer rid )   
  • proc set_open_url_event( atom html_win, integer rid )   
  • proc set_related_frame( atom html_win, atom frame, sequence format )     
     
    Parent Topics:
  • Classes
  • Controls


    Table of Contents

    [func]
    get_html_anchor
    ( atom html_win )

    Category: wxHtmlWindow

    Returns anchor within currently opened page (see get_html_page()). If no page is opened or if the displayed page wasn't produced by call to LoadPage, empty string is returned.

    See Also: get_html_page, get_html_page_title, get_html_page_title, html_append, html_back, html_forward, load_html_file, load_html_page, set_html_page, set_link_event, set_open_url_event, set_related_frame



    Table of Contents

    [func]
    get_html_page
    ( atom html_win )

    Category: wxHtmlWindow

    Returns full location of the opened page. If no page is opened or if the displayed page wasn't produced by call to LoadPage, empty string is returned.

    See Also: get_html_anchor, get_html_page_title, get_html_page_title, html_append, html_back, html_forward, load_html_file, load_html_page, set_html_page, set_link_event, set_open_url_event, set_related_frame



    Table of Contents

    [proc]
    get_html_page_title
    ( atom html_win )

    Category: wxHtmlWindow

    Clears the history cache.

    See Also: get_html_anchor, get_html_page, get_html_page_title, html_append, html_back, html_forward, load_html_file, load_html_page, set_html_page, set_link_event, set_open_url_event, set_related_frame



    Table of Contents

    [proc]
    get_html_page_title
    ( atom html_win )

    Category: wxHtmlWindow

    Returns the title of the currently opened page.

    See Also: get_html_anchor, get_html_page, get_html_page_title, html_append, html_back, html_forward, load_html_file, load_html_page, set_html_page, set_link_event, set_open_url_event, set_related_frame



    Table of Contents

    [proc]
    html_append
    ( atom htmlwin, sequence source)

    Category: wxHtmlWindow

    This appends the HTML Source to the Control

    See Also: get_html_anchor, get_html_page, get_html_page_title, get_html_page_title, html_back, html_forward, load_html_file, load_html_page, set_html_page, set_link_event, set_open_url_event, set_related_frame



    Table of Contents

    [proc]
    html_back
    ( atom htmlwin )

    Category: wxHtmlWindow

    See Also: get_html_anchor, get_html_page, get_html_page_title, get_html_page_title, html_append, html_forward, load_html_file, load_html_page, set_html_page, set_link_event, set_open_url_event, set_related_frame



    Table of Contents

    [proc]
    html_forward
    ( atom htmlwin )

    Category: wxHtmlWindow

    See Also: get_html_anchor, get_html_page, get_html_page_title, get_html_page_title, html_append, html_back, load_html_file, load_html_page, set_html_page, set_link_event, set_open_url_event, set_related_frame



    Table of Contents

    [proc]
    load_html_file
    ( atom htmlwin, sequence file)

    Category: wxHtmlWindow

    Loads the specified file.

    See Also: get_html_anchor, get_html_page, get_html_page_title, get_html_page_title, html_append, html_back, html_forward, load_html_page, set_html_page, set_link_event, set_open_url_event, set_related_frame



    Table of Contents

    [proc]
    load_html_page
    ( atom htmlwin, sequence page )

    Category: wxHtmlWindow

    See Also: get_html_anchor, get_html_page, get_html_page_title, get_html_page_title, html_append, html_back, html_forward, load_html_file, set_html_page, set_link_event, set_open_url_event, set_related_frame



    Table of Contents

    [proc]
    set_html_page
    ( atom htmlwin, sequence source )

    Category: wxHtmlWindow

    This sets the source of the displayed page to source.

    See Also: get_html_anchor, get_html_page, get_html_page_title, get_html_page_title, html_append, html_back, html_forward, load_html_file, load_html_page, set_link_event, set_open_url_event, set_related_frame



    Table of Contents

    [proc]
    set_link_event
    ( atom html_win, integer rid )

    Category: wxHtmlWindow

    Set a callback for when the user clicks on a link in a wxHtmlWindow. The callback must be a procedure that takes 3 parameters:

    If you trap this event, you must call load_html_page() in order for the link to execute.

    See Also: get_html_anchor, get_html_page, get_html_page_title, get_html_page_title, html_append, html_back, html_forward, load_html_file, load_html_page, set_html_page, set_open_url_event, set_related_frame



    Table of Contents

    [proc]
    set_open_url_event
    ( atom html_win, integer rid )

    Category: wxHtmlWindow

    Set a call_back to be called when an URL is being opened (either when the user clicks on a link or an image is loaded). The URL will be opened only if the call back returns wxHTML_OPEN. This method is called by wxHtmlParser::OpenURL. You can use the call back to selectively block some URLs (e.g. for security reasons) or to redirect them elsewhere. Default behaviour is to always return wxHTML_OPEN.

    Parameters

    Call back return value:

    See Also: get_html_anchor, get_html_page, get_html_page_title, get_html_page_title, html_append, html_back, html_forward, load_html_file, load_html_page, set_html_page, set_link_event, set_related_frame



    Table of Contents

    [proc]
    set_related_frame
    ( atom html_win, atom frame, sequence format )

    Category: wxHtmlWindow

    Sets the frame in which page title will be displayed. format is format of frame title, e.g. "HtmlHelp : %s". It must contain exactly one %s. This %s is substituted with HTML page title. status_slot is the slot in the status bar where messages will be displayed (-1 means no messages).

    See Also: get_html_anchor, get_html_page, get_html_page_title, get_html_page_title, html_append, html_back, html_forward, load_html_file, load_html_page, set_html_page, set_link_event, set_open_url_event