[wx-dev] wxAUI class renaming proprosal

[Vadim Zeitlin]

On Wed, 1 Nov 2006 13:16:34 +0100 Benjamin Williams <kxbwilliams at gmail.com> wrote:

BW> A few threads ago the idea of a large wxAUI class renaming was
BW> proposed.  As I'm not against this myself, I'd like to ask everyone
BW> for their comments before proceeding one way or another.

 I definitely think we need to rename the classes, currently it's not clear
at all that wxFrameManager and wxTabArt are both members of AUI.

BW> The only disadvantages that I can think of are that everybody will
BW> have to change their code that calls wxAUI,

 If there is a lot of existing code we might consider defining the old
names as synonyms for the new ones. But I'd prefer to avoid doing this.

BW> Almost all constants already have a wxAUI_ prefix.
BW> 
BW> Aggressive renaming would yield:
BW> 
BW>     wxFrameManager -> wxAuiManager
BW>     wxFrameManagerEvent -> wxAuiManagerEvent
BW>     wxPaneInfo -> wxAuiPaneInfo
BW>     wxFloatingPane -> wxAuiFloatingPane
BW>     wxDockArt -> wxAuiDockArt
BW>     wxTabArt -> wxAuiTabArt
BW>     wxAuiMultiNotebook -> wxAuiNotebook
BW>     wxAuiNotebookEvent -> wxAuiNotebookEvent
BW>     wxTabMDIParentFrame -> wxAuiMDIParentFrame
BW>     wxTabMDIChildFrame -> wxAuiMDIChildFrame
BW>     wxTabMDIClientWindow -> wxAuiTabMDIClientWindow

 Especially seeing that some classes already have "wxAui" prefix, it really
makes sense to rename the other ones too IMO. The only question for me is
whether we should use wxAui or something more readable/immediately
understandable such as wxDockable prefix proposed by Robert.

BW> So what would everyone like to see?  If we do decide to undertake a
BW> large class rename, now is the time to do it, because this is the
BW> first time wxAUI will be included in a stable release.

 Yes, and hopefully even though it's a big change it shouldn't break
anything as it's just a mechanical substitution. Just please don't forget
to check that the docs still build afterwards (i.e. no hyperlinks were
broken).

 Thanks,
VZ