XRC spec: document wxRibbon* XRC handler.
Format documentation was nonexistent (the few words present were incorrect). Document my best guess about the intended usage. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74925 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -1486,10 +1486,17 @@ Example:
|
|||||||
@endcode
|
@endcode
|
||||||
|
|
||||||
|
|
||||||
@subsubsection xrc_wxribbon wxRibbonBar
|
@subsubsection xrc_wxribbonbar wxRibbonBar
|
||||||
|
|
||||||
A wxRibbonBar is a container of ribbon pages which, in turn, contain elements
|
@beginTable
|
||||||
that can be wxRibbonControl or wxRibbonGallery.
|
@hdr3col{property, type, description}
|
||||||
|
@row3col{art-provider, @ref overview_xrcformat_type_string,
|
||||||
|
One of @c default, @c aui or @c msw (default: @c default).}
|
||||||
|
@endTable
|
||||||
|
|
||||||
|
A wxRibbonBar may have @ref xrc_wxribbonpage child objects. The @c page
|
||||||
|
pseudo-class may be used instead of @c wxRibbonPage when used as wxRibbonBar
|
||||||
|
children.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
@code
|
@code
|
||||||
@@ -1533,6 +1540,85 @@ later only and you need to explicitly register its handler using
|
|||||||
to use it.
|
to use it.
|
||||||
|
|
||||||
|
|
||||||
|
@subsubsection xrc_wxribbonbuttonbar wxRibbonButtonBar
|
||||||
|
|
||||||
|
No additional properties.
|
||||||
|
|
||||||
|
wxRibbonButtonBar can have child objects of the @c button pseudo-class. @c button
|
||||||
|
objects have the following properties:
|
||||||
|
|
||||||
|
@beginTable
|
||||||
|
@hdr3col{property, type, description}
|
||||||
|
@row3col{hybrid, @ref overview_xrcformat_type_bool,
|
||||||
|
If true, the @c wxRIBBON_BUTTON_HYBRID kind is used (default: false).}
|
||||||
|
@row3col{disabled, @ref overview_xrcformat_type_bool,
|
||||||
|
Whether the button should be disabled (default: false).}
|
||||||
|
@row3col{label, @ref overview_xrcformat_type_text,
|
||||||
|
Item's label (required).}
|
||||||
|
@row3col{bitmap, @ref overview_xrcformat_type_bitmap,
|
||||||
|
Item's bitmap (required).}
|
||||||
|
@row3col{small-bitmap, @ref overview_xrcformat_type_bitmap,
|
||||||
|
Small bitmap (default: none).}
|
||||||
|
@row3col{disabled-bitmap, @ref overview_xrcformat_type_bitmap,
|
||||||
|
Disabled bitmap (default: none).}
|
||||||
|
@row3col{small-disabled-bitmap, @ref overview_xrcformat_type_bitmap,
|
||||||
|
Small disabled bitmap (default: none).}
|
||||||
|
@row3col{help, @ref overview_xrcformat_type_text,
|
||||||
|
Item's help text (default: none).}
|
||||||
|
@endTable
|
||||||
|
|
||||||
|
|
||||||
|
@subsubsection xrc_wxribboncontrol wxRibbonControl
|
||||||
|
|
||||||
|
No additional properties.
|
||||||
|
|
||||||
|
Objects of this type *must* be subclassed with the @c subclass attribute.
|
||||||
|
|
||||||
|
|
||||||
|
@subsubsection xrc_wxribbongallery wxRibbonGallery
|
||||||
|
|
||||||
|
No additional properties.
|
||||||
|
|
||||||
|
wxRibbonGallery can have child objects of the @c item pseudo-class. @c item
|
||||||
|
objects have the following properties:
|
||||||
|
|
||||||
|
@beginTable
|
||||||
|
@hdr3col{property, type, description}
|
||||||
|
@row3col{bitmap, @ref overview_xrcformat_type_bitmap,
|
||||||
|
Item's bitmap (default: none).}
|
||||||
|
@endTable
|
||||||
|
|
||||||
|
|
||||||
|
@subsubsection xrc_wxribbonpage wxRibbonPage
|
||||||
|
|
||||||
|
@beginTable
|
||||||
|
@hdr3col{property, type, description}
|
||||||
|
@row3col{label, @ref overview_xrcformat_type_text,
|
||||||
|
Label (default: none).}
|
||||||
|
@row3col{icon, @ref overview_xrcformat_type_bitmap,
|
||||||
|
Icon (default: none).}
|
||||||
|
@endTable
|
||||||
|
|
||||||
|
A wxRibbonPage may have children of any type derived from wxRibbonControl.
|
||||||
|
Most commontly, wxRibbonPanel is used. As a special case, the @c panel
|
||||||
|
pseudo-class may be used instead of @c wxRibbonPanel when used as wxRibbonPage
|
||||||
|
children.
|
||||||
|
|
||||||
|
|
||||||
|
@subsubsection xrc_wxribbonpanel wxRibbonPanel
|
||||||
|
|
||||||
|
@beginTable
|
||||||
|
@hdr3col{property, type, description}
|
||||||
|
@row3col{label, @ref overview_xrcformat_type_text,
|
||||||
|
Label (default: none).}
|
||||||
|
@row3col{icon, @ref overview_xrcformat_type_bitmap,
|
||||||
|
Icon (default: none).}
|
||||||
|
@endTable
|
||||||
|
|
||||||
|
A wxRibbonPanel may have children of any type derived from wxRibbonControl or
|
||||||
|
a single wxSizer child with non-ribbon windows in it.
|
||||||
|
|
||||||
|
|
||||||
@subsubsection xrc_wxrichtextctrl wxRichTextCtrl
|
@subsubsection xrc_wxrichtextctrl wxRichTextCtrl
|
||||||
|
|
||||||
@beginTable
|
@beginTable
|
||||||
|
@@ -150,6 +150,8 @@ wxObject* wxRibbonXmlHandler::Handle_button()
|
|||||||
// with the xml library. Disable it for now but the real solution
|
// with the xml library. Disable it for now but the real solution
|
||||||
// would be to virtualize GetChildren() and GetNext() methods via
|
// would be to virtualize GetChildren() and GetNext() methods via
|
||||||
// wxXmlResourceHandler, just as we already do for many others.
|
// wxXmlResourceHandler, just as we already do for many others.
|
||||||
|
//
|
||||||
|
// FIXME: If re-enabling, don't forget to update the docs and RELAG NG schema!
|
||||||
#if 0 // wxUSE_MENUS
|
#if 0 // wxUSE_MENUS
|
||||||
// check whether we have dropdown tag inside
|
// check whether we have dropdown tag inside
|
||||||
wxMenu *menu = NULL; // menu for drop down items
|
wxMenu *menu = NULL; // menu for drop down items
|
||||||
|
Reference in New Issue
Block a user