From 6ff9dc034da0cfe3909aa7ce891e927c8a2ccc2d Mon Sep 17 00:00:00 2001 From: Robert Roebling Date: Fri, 1 Sep 2006 21:37:22 +0000 Subject: [PATCH] Began to move wxAUI docs to latex. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@40950 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/classes.tex | 2 + docs/latex/wx/framemanager.tex | 378 +++++++++++++++++++++++++++ docs/latex/wx/paneinfo.tex | 454 +++++++++++++++++++++++++++++++++ docs/latex/wx/taui.tex | 45 ++++ docs/latex/wx/topics.tex | 1 + 5 files changed, 880 insertions(+) create mode 100644 docs/latex/wx/framemanager.tex create mode 100644 docs/latex/wx/paneinfo.tex create mode 100644 docs/latex/wx/taui.tex diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex index 40f5af0b1a..9f43d36ef8 100644 --- a/docs/latex/wx/classes.tex +++ b/docs/latex/wx/classes.tex @@ -142,6 +142,7 @@ \input fontmap.tex \input fontpicker.tex \input frame.tex +\input framemanager.tex \input fsfile.tex \input ftp.tex \input gauge.tex @@ -259,6 +260,7 @@ \input paintdc.tex \input paintevt.tex \input palette.tex +\input paneinfo.tex \input panel.tex \input passdlg.tex \input pathlist.tex diff --git a/docs/latex/wx/framemanager.tex b/docs/latex/wx/framemanager.tex new file mode 100644 index 0000000000..cc2385d487 --- /dev/null +++ b/docs/latex/wx/framemanager.tex @@ -0,0 +1,378 @@ +\section{\class{wxFrameManager}}\label{wxframemanager} + +wxFrameManager is the central class of the wxAUI class framework. + +See also \helpref{wxAUI overview}{wxauioverview}. + +wxFrameManager manages the panes associated with it +for a particular wxFrame, using a pane's wxPaneInfo information to +determine each pane's docking and floating behavior. wxFrameManager +uses wxWidgets' sizer mechanism to plan the layout of each frame. It +uses a replaceable dock art class to do all drawing, so all drawing is +localized in one area, and may be customized depending on an +applications' specific needs. + +wxFrameManager works as follows: The programmer adds panes to the class, +or makes changes to existing pane properties (dock position, floating +state, show state, etc.). To apply these changes, wxFrameManager's +Update() function is called. This batch processing can be used to avoid +flicker, by modifying more than one pane at a time, and then "committing" +all of the changes at once by calling Update(). + +Panes can be added quite easily: + +\begin{verbatim} +wxTextCtrl* text1 = new wxTextCtrl(this, -1); +wxTextCtrl* text2 = new wxTextCtrl(this, -1); +m_mgr.AddPane(text1, wxLEFT, wxT("Pane Caption")); +m_mgr.AddPane(text2, wxBOTTOM, wxT("Pane Caption")); +m_mgr.Update(); +\end{verbatim} + +Later on, the positions can be modified easily. The following will float +an existing pane in a tool window: + +\begin{verbatim} +m_mgr.GetPane(text1).Float(); +\end{verbatim} + +\wxheading{Layers, Rows and Directions, Positions} + +Inside wxAUI, the docking layout is figured out by checking several +pane parameters. Four of these are important for determining where a +pane will end up: + +{\bf Direction:} +Each docked pane has a direction, Top, Bottom, Left, Right, or +Center. This is fairly self-explanatory. The pane will be placed in the +location specified by this variable. + +{\bf Position:} +More than one pane can be placed inside of a dock. Imagine to panes +being docked on the left side of a window. One pane can be placed over +another. In proportionally managed docks, the pane position indicates +it's sequential position, starting with zero. So, in our scenario with +two panes docked on the left side, the top pane in the dock would have +position 0, and the second one would occupy position 1. + +{\bf Row:} +A row can allow for two docks to be placed next to each other. One of +the most common places for this to happen is in the toolbar. Multiple +toolbar rows are allowed, the first row being in row 0, and the second +in row 1. Rows can also be used on vertically docked panes. + + +{\bf Layer:} +A layer is akin to an onion. Layer 0 is the very center of the +managed pane. Thus, if a pane is in layer 0, it will be closest to the +center window (also sometimes known as the "content window"). +Increasing layers "swallow up" all layers of a lower value. This can +look very similar to multiple rows, but is different because all panes +in a lower level yield to panes in higher levels. The best way to +understand layers is by running the wxAUI sample. + +\wxheading{Derived from} + +\helpref{wxEvent}{wxevent} + +\wxheading{Include files} + + + +\wxheading{See also} + +\helpref{wxPaneInfo}{wxpaneinfo} + +\wxheading{Data structures} + +\begin{verbatim} +enum wxFrameManagerDock +{ + wxAUI_DOCK_NONE = 0, + wxAUI_DOCK_TOP = 1, + wxAUI_DOCK_RIGHT = 2, + wxAUI_DOCK_BOTTOM = 3, + wxAUI_DOCK_LEFT = 4, + wxAUI_DOCK_CENTER = 5, + wxAUI_DOCK_CENTRE = wxAUI_DOCK_CENTER +} +\end{verbatim} + +\begin{verbatim} +enum wxFrameManagerOption +{ + wxAUI_MGR_ALLOW_FLOATING = 1 << 0, + wxAUI_MGR_ALLOW_ACTIVE_PANE = 1 << 1, + wxAUI_MGR_TRANSPARENT_DRAG = 1 << 2, + wxAUI_MGR_TRANSPARENT_HINT = 1 << 3, + wxAUI_MGR_TRANSPARENT_HINT_FADE = 1 << 4, + wxAUI_MGR_DISABLE_VENETIAN_BLINDS = 1 << 5, + wxAUI_MGR_DISABLE_VENETIAN_BLINDS_FADE = 1 << 6, + + wxAUI_MGR_DEFAULT = wxAUI_MGR_ALLOW_FLOATING | + wxAUI_MGR_TRANSPARENT_HINT | + wxAUI_MGR_TRANSPARENT_HINT_FADE | + wxAUI_MGR_DISABLE_VENETIAN_BLINDS_FADE +} +\end{verbatim} + + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxFrameManager::wxFrameManager}\label{wxframemanagerwxframemanager} + +\func{}{wxFrameManager}{\param{wxWindow* }{managed\_wnd = NULL}, \param{unsigned int }{flags = wxAUI\_MGR\_DEFAULT}} + +Constructor. {\it frame} specifies the wxFrame which should be managed. +{\it flags} specifies options which allow the frame management behavior +to be modified. + +\membersection{wxFrameManager::\destruct{wxFrameManager}}\label{wxframemanagerdtor} + +\func{}{\destruct{wxFrameManager}}{\void} + + +\membersection{wxFrameManager::AddPane}\label{wxframemanageraddpane} + +\func{bool}{AddPane}{\param{wxWindow* }{window}, \param{const wxPaneInfo\& }{pane\_info}} + + +\func{bool}{AddPane}{\param{wxWindow* }{window}, \param{const wxPaneInfo\& }{pane\_info}, \param{const wxPoint\& }{drop\_pos}} + + +\func{bool}{AddPane}{\param{wxWindow* }{window}, \param{int }{direction = wxLEFT}, \param{const wxString\& }{caption = wxEmptyString}} + +Tells the frame manager to start managing a child window. + +\membersection{wxFrameManager::DetachPane}\label{wxframemanagerdetachpane} + +\func{bool}{DetachPane}{\param{wxWindow* }{window}} + +Tells the wxFrameManager to stop managing the pane specified by window. +The window, if in a floated frame, is reparented to the frame managed +by wxFrameManager. + +\membersection{wxFrameManager::DoDrop}\label{wxframemanagerdodrop} + +\func{bool}{DoDrop}{\param{wxDockInfoArray\& }{docks}, \param{wxPaneInfoArray\& }{panes}, \param{wxPaneInfo\& }{drop}, \param{const wxPoint\& }{pt}, \param{const wxPoint\& }{action\_offset = wxPoint(0,0)}} + + +\membersection{wxFrameManager::DoFrameLayout}\label{wxframemanagerdoframelayout} + +\func{void}{DoFrameLayout}{\void} + + +\membersection{wxFrameManager::DrawHintRect}\label{wxframemanagerdrawhintrect} + +\func{void}{DrawHintRect}{\param{wxWindow* }{pane\_window}, \param{const wxPoint\& }{pt}, \param{const wxPoint\& }{offset}} + + +\membersection{wxFrameManager::GetAllPanes}\label{wxframemanagergetallpanes} + +\func{wxPaneInfoArray\&}{GetAllPanes}{\void} + +Returns an array of all panes managed by the frame manager. + +\membersection{wxFrameManager::GetArtProvider}\label{wxframemanagergetartprovider} + +\constfunc{wxDockArt*}{GetArtProvider}{\void} + +Returns the current art provider being used. + +\membersection{wxFrameManager::GetDockPixelOffset}\label{wxframemanagergetdockpixeloffset} + +\func{int}{GetDockPixelOffset}{\param{wxPaneInfo\& }{test}} + + +\membersection{wxFrameManager::GetFlags}\label{wxframemanagergetflags} + +\constfunc{unsigned int}{GetFlags}{\void} + +Returns the current manager's flags. + +\membersection{wxFrameManager::GetManagedWindow}\label{wxframemanagergetmanagedwindow} + +\constfunc{wxWindow*}{GetManagedWindow}{\void} + +Returns the frame currently being managed by wxFrameManager. + +\membersection{wxFrameManager::GetPane}\label{wxframemanagergetpane} + +\func{wxPaneInfo\&}{GetPane}{\param{wxWindow* }{window}} + +{\it GetPane]} is used to lookup a wxPaneInfo object +either by window pointer or by pane name, which acts as a unique id for +a window pane. The returned wxPaneInfo object may then be modified to +change a pane's look, state or position. After one or more +modifications to wxPaneInfo, wxFrameManager::Update() should be called +to commit the changes to the user interface. If the lookup failed +(meaning the pane could not be found in the manager), a call to the +returned wxPaneInfo's IsOk() method will return false. + +\func{wxPaneInfo\&}{GetPane}{\param{const wxString\& }{name}} + + +\membersection{wxFrameManager::GetPanePart}\label{wxframemanagergetpanepart} + +\func{wxDockUIPart*}{GetPanePart}{\param{wxWindow* }{pane}} + + +\membersection{wxFrameManager::GetPanePositionsAndSizes}\label{wxframemanagergetpanepositionsandsizes} + +\func{void}{GetPanePositionsAndSizes}{\param{wxDockInfo\& }{dock}, \param{wxArrayInt\& }{positions}, \param{wxArrayInt\& }{sizes}} + + +\membersection{wxFrameManager::HideHint}\label{wxframemanagerhidehint} + +\func{void}{HideHint}{\void} + + +\membersection{wxFrameManager::HitTest}\label{wxframemanagerhittest} + +\func{wxDockUIPart*}{HitTest}{\param{int }{x}, \param{int }{y}} + + +\membersection{wxFrameManager::InsertPane}\label{wxframemanagerinsertpane} + +\func{bool}{InsertPane}{\param{wxWindow* }{window}, \param{const wxPaneInfo\& }{insert\_location}, \param{int }{insert\_level = wxAUI\_INSERT\_PANE}} + +This method is used to insert either a previously unmanaged pane window +into the frame manager, or to insert a currently managed pane somewhere +else. {\it InsertPane} will push all panes, rows, or docks aside and +insert the window into the position specified by insert_location. +Because insert_location can specify either a pane, dock row, or dock +layer, the insert_level parameter is used to disambiguate this. The +parameter insert_level can take a value of wxAUI\_INSERT\_PANE, wxAUI\_INSERT\_ROW +or wxAUI\_INSERT\_DOCK. + +\membersection{wxFrameManager::LayoutAddDock}\label{wxframemanagerlayoutadddock} + +\func{void}{LayoutAddDock}{\param{wxSizer* }{container}, \param{wxDockInfo\& }{dock}, \param{wxDockUIPartArray\& }{uiparts}, \param{bool }{spacer\_only}} + + +\membersection{wxFrameManager::LayoutAddPane}\label{wxframemanagerlayoutaddpane} + +\func{void}{LayoutAddPane}{\param{wxSizer* }{container}, \param{wxDockInfo\& }{dock}, \param{wxPaneInfo\& }{pane}, \param{wxDockUIPartArray\& }{uiparts}, \param{bool }{spacer\_only}} + + +\membersection{wxFrameManager::LayoutAll}\label{wxframemanagerlayoutall} + +\func{wxSizer*}{LayoutAll}{\param{wxPaneInfoArray\& }{panes}, \param{wxDockInfoArray\& }{docks}, \param{wxDockUIPartArray\& }{uiparts}, \param{bool }{spacer\_only = false}} + + +\membersection{wxFrameManager::LoadPaneInfo}\label{wxframemanagerloadpaneinfo} + +\func{void}{LoadPaneInfo}{\param{wxString }{pane\_part}, \param{wxPaneInfo\& }{pane}} + + +\membersection{wxFrameManager::LoadPerspective}\label{wxframemanagerloadperspective} + +\func{bool}{LoadPerspective}{\param{const wxString\& }{perspective}, \param{bool }{update = true}} + +Loads a saved perspective. If update is true, wxFrameManager::Update() +is automatically invoked, thus realizing the saved perspective on screen. + +\membersection{wxFrameManager::LookupPane}\label{wxframemanagerlookuppane} + +\func{wxPaneInfo\&}{LookupPane}{\param{wxWindow* }{window}} + + +\func{wxPaneInfo\&}{LookupPane}{\param{const wxString\& }{name}} + + +\membersection{wxFrameManager::ProcessDockResult}\label{wxframemanagerprocessdockresult} + +\func{bool}{ProcessDockResult}{\param{wxPaneInfo\& }{target}, \param{const wxPaneInfo\& }{new\_pos}} + + +\membersection{wxFrameManager::ProcessMgrEvent}\label{wxframemanagerprocessmgrevent} + +\func{void}{ProcessMgrEvent}{\param{wxFrameManagerEvent\& }{event}} + + +\membersection{wxFrameManager::Render}\label{wxframemanagerrender} + +\func{void}{Render}{\param{wxDC* }{dc}} + + +\membersection{wxFrameManager::Repaint}\label{wxframemanagerrepaint} + +\func{void}{Repaint}{\param{wxDC* }{dc = NULL}} + + +\membersection{wxFrameManager::SavePaneInfo}\label{wxframemanagersavepaneinfo} + +\func{wxString}{SavePaneInfo}{\param{wxPaneInfo\& }{pane}} + + +\membersection{wxFrameManager::SavePerspective}\label{wxframemanagersaveperspective} + +\func{wxString}{SavePerspective}{\void} + +Saves the entire user interface layout into an encoded wxString, which +can then be stored by the application (probably using wxConfig). When +a perspective is restored using LoadPerspective(), the entire user +interface will return to the state it was when the perspective was saved. + +\membersection{wxFrameManager::SetArtProvider}\label{wxframemanagersetartprovider} + +\func{void}{SetArtProvider}{\param{wxDockArt* }{art\_provider}} + +Instructs wxFrameManager to use art provider specified by parameter +{\it art_provider} for all drawing calls. This allows plugable +look-and-feel features. The previous art provider object, if any, +will be deleted by wxFrameManager. + +\membersection{wxFrameManager::SetFlags}\label{wxframemanagersetflags} + +\func{void}{SetFlags}{\param{unsigned int }{flags}} + +This method is used to specify wxFrameManager's settings flags. {\it flags} +specifies options which allow the frame management behavior to be modified. + +\membersection{wxFrameManager::SetManagedWindow}\label{wxframemanagersetmanagedwindow} + +\func{void}{SetManagedWindow}{\param{wxWindow* }{managed\_wnd}} + +Called to specify the frame which is to be managed by wxFrameManager. + +\membersection{wxFrameManager::ShowHint}\label{wxframemanagershowhint} + +\func{void}{ShowHint}{\param{const wxRect\& }{rect}} + + +\membersection{wxFrameManager::UnInit}\label{wxframemanageruninit} + +\func{void}{UnInit}{\void} + +Uninitializes the framework and should be called before a frame is +destroyed. UnInit() is usually called in the managed wxFrame's destructor. + +\membersection{wxFrameManager::Update}\label{wxframemanagerupdate} + +\func{void}{Update}{\void} + +This method is called after any number of changes are +made to any of the managed panes. Update() must be invoked after +AddPane() or InsertPane() are called in order to "realize" or "commit" +the changes. In addition, any number of changes may be made to +wxPaneInfo structures (retrieved with wxFrameManager::GetPane), but to +realize the changes, Update() must be called. This construction allows +pane flicker to be avoided by updating the whole layout at one time. + +\membersection{wxFrameManager::UpdateButtonOnScreen}\label{wxframemanagerupdatebuttononscreen} + +\func{void}{UpdateButtonOnScreen}{\param{wxDockUIPart* }{button\_ui\_part}, \param{const wxMouseEvent\& }{event}} + + +\membersection{wxFrameManager::wxDEPRECATED}\label{wxframemanagerwxdeprecated} + +\func{}{wxDEPRECATED}{\param{void }{SetFrame(wxFrame* frame)}} + +deprecated -- please use SetManagedWindow() and +and GetManagedWindow() instead + + +\func{}{wxDEPRECATED}{\param{wxFrame* GetFrame() }{const}} + diff --git a/docs/latex/wx/paneinfo.tex b/docs/latex/wx/paneinfo.tex new file mode 100644 index 0000000000..3f11e22598 --- /dev/null +++ b/docs/latex/wx/paneinfo.tex @@ -0,0 +1,454 @@ +\section{\class{wxPaneInfo}}\label{wxpaneinfo} + +wxPaneInfo is part of the wxAUI class framework. +See also \helpref{wxAUI overview}{wxauioverview}. + +wxPaneInfo specifies all the parameters for a pane. +These parameters specify where the pane is on the +screen, whether it is docked or floating, or hidden. +In addition, these parameters specify the pane's +docked position, floating position, preferred size, +minimum size, caption text among many other parameters. + +\wxheading{Derived from} + +No base class + +\wxheading{Include files} + + + +\wxheading{See also} + +\helpref{wxFrameManager}{wxframemanager} + +\wxheading{Data structures} + +\begin{verbatim} +enum wxPaneDockArtSetting +{ + wxAUI_ART_SASH_SIZE = 0, + wxAUI_ART_CAPTION_SIZE = 1, + wxAUI_ART_GRIPPER_SIZE = 2, + wxAUI_ART_PANE_BORDER_SIZE = 3, + wxAUI_ART_PANE_BUTTON_SIZE = 4, + wxAUI_ART_BACKGROUND_COLOUR = 5, + wxAUI_ART_SASH_COLOUR = 6, + wxAUI_ART_ACTIVE_CAPTION_COLOUR = 7, + wxAUI_ART_ACTIVE_CAPTION_GRADIENT_COLOUR = 8, + wxAUI_ART_INACTIVE_CAPTION_COLOUR = 9, + wxAUI_ART_INACTIVE_CAPTION_GRADIENT_COLOUR = 10, + wxAUI_ART_ACTIVE_CAPTION_TEXT_COLOUR = 11, + wxAUI_ART_INACTIVE_CAPTION_TEXT_COLOUR = 12, + wxAUI_ART_BORDER_COLOUR = 13, + wxAUI_ART_GRIPPER_COLOUR = 14, + wxAUI_ART_CAPTION_FONT = 15, + wxAUI_ART_GRADIENT_TYPE = 16 +} +\end{verbatim} + +\begin{verbatim} +enum wxPaneDockArtGradients +{ + wxAUI_GRADIENT_NONE = 0, + wxAUI_GRADIENT_VERTICAL = 1, + wxAUI_GRADIENT_HORIZONTAL = 2 +} +\end{verbatim} + +\begin{verbatim} +enum wxPaneButtonState +{ + wxAUI_BUTTON_STATE_NORMAL = 0, + wxAUI_BUTTON_STATE_HOVER = 1, + wxAUI_BUTTON_STATE_PRESSED = 2 +} +\end{verbatim} + +\begin{verbatim} +enum wxPaneInsertLevel +{ + wxAUI_INSERT_PANE = 0, + wxAUI_INSERT_ROW = 1, + wxAUI_INSERT_DOCK = 2 +} +\end{verbatim} + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxPaneInfo::wxPaneInfo}\label{wxpaneinfowxpaneinfo} + +\func{}{wxPaneInfo}{\void} + + +\func{}{wxPaneInfo}{\param{const wxPaneInfo\& }{c}} + + +\membersection{wxPaneInfo::\destruct{wxPaneInfo}}\label{wxpaneinfodtor} + +\func{}{\destruct{wxPaneInfo}}{\void} + + +\membersection{wxPaneInfo::BestSize}\label{wxpaneinfobestsize} + +\func{wxPaneInfo\&}{BestSize}{\param{const wxSize\& }{size}} + + +\func{wxPaneInfo\&}{BestSize}{\param{int }{x}, \param{int }{y}} + + +\membersection{wxPaneInfo::Bottom}\label{wxpaneinfobottom} + +\func{wxPaneInfo\&}{Bottom}{\void} + + +\membersection{wxPaneInfo::BottomDockable}\label{wxpaneinfobottomdockable} + +\func{wxPaneInfo\&}{BottomDockable}{\param{bool }{b = true}} + + +\membersection{wxPaneInfo::Caption}\label{wxpaneinfocaption} + +\func{wxPaneInfo\&}{Caption}{\param{const wxString\& }{c}} + + +\membersection{wxPaneInfo::CaptionVisible}\label{wxpaneinfocaptionvisible} + +\func{wxPaneInfo\&}{CaptionVisible}{\param{bool }{visible = true}} + + +\membersection{wxPaneInfo::Center}\label{wxpaneinfocenter} + +\func{wxPaneInfo\&}{Center}{\void} + + +\membersection{wxPaneInfo::CenterPane}\label{wxpaneinfocenterpane} + +\func{wxPaneInfo\&}{CenterPane}{\void} + + +\membersection{wxPaneInfo::Centre}\label{wxpaneinfocentre} + +\func{wxPaneInfo\&}{Centre}{\void} + + +\membersection{wxPaneInfo::CentrePane}\label{wxpaneinfocentrepane} + +\func{wxPaneInfo\&}{CentrePane}{\void} + + +\membersection{wxPaneInfo::CloseButton}\label{wxpaneinfoclosebutton} + +\func{wxPaneInfo\&}{CloseButton}{\param{bool }{visible = true}} + + +\membersection{wxPaneInfo::DefaultPane}\label{wxpaneinfodefaultpane} + +\func{wxPaneInfo\&}{DefaultPane}{\void} + + +\membersection{wxPaneInfo::DestroyOnClose}\label{wxpaneinfodestroyonclose} + +\func{wxPaneInfo\&}{DestroyOnClose}{\param{bool }{b = true}} + + +\membersection{wxPaneInfo::Direction}\label{wxpaneinfodirection} + +\func{wxPaneInfo\&}{Direction}{\param{int }{direction}} + + +\membersection{wxPaneInfo::Dock}\label{wxpaneinfodock} + +\func{wxPaneInfo\&}{Dock}{\void} + + +\membersection{wxPaneInfo::Dockable}\label{wxpaneinfodockable} + +\func{wxPaneInfo\&}{Dockable}{\param{bool }{b = true}} + + +\membersection{wxPaneInfo::Fixed}\label{wxpaneinfofixed} + +\func{wxPaneInfo\&}{Fixed}{\void} + + +\membersection{wxPaneInfo::Float}\label{wxpaneinfofloat} + +\func{wxPaneInfo\&}{Float}{\void} + + +\membersection{wxPaneInfo::Floatable}\label{wxpaneinfofloatable} + +\func{wxPaneInfo\&}{Floatable}{\param{bool }{b = true}} + + +\membersection{wxPaneInfo::FloatingPosition}\label{wxpaneinfofloatingposition} + +\func{wxPaneInfo\&}{FloatingPosition}{\param{const wxPoint\& }{pos}} + + +\func{wxPaneInfo\&}{FloatingPosition}{\param{int }{x}, \param{int }{y}} + + +\membersection{wxPaneInfo::FloatingSize}\label{wxpaneinfofloatingsize} + +\func{wxPaneInfo\&}{FloatingSize}{\param{const wxSize\& }{size}} + + +\func{wxPaneInfo\&}{FloatingSize}{\param{int }{x}, \param{int }{y}} + + +\membersection{wxPaneInfo::Gripper}\label{wxpaneinfogripper} + +\func{wxPaneInfo\&}{Gripper}{\param{bool }{visible = true}} + + +\membersection{wxPaneInfo::GripperTop}\label{wxpaneinfogrippertop} + +\func{wxPaneInfo\&}{GripperTop}{\param{bool }{attop = true}} + + +\membersection{wxPaneInfo::HasBorder}\label{wxpaneinfohasborder} + +\constfunc{bool}{HasBorder}{\void} + + +\membersection{wxPaneInfo::HasCaption}\label{wxpaneinfohascaption} + +\constfunc{bool}{HasCaption}{\void} + + +\membersection{wxPaneInfo::HasCloseButton}\label{wxpaneinfohasclosebutton} + +\constfunc{bool}{HasCloseButton}{\void} + + +\membersection{wxPaneInfo::HasFlag}\label{wxpaneinfohasflag} + +\constfunc{bool}{HasFlag}{\param{unsigned int }{flag}} + + +\membersection{wxPaneInfo::HasGripper}\label{wxpaneinfohasgripper} + +\constfunc{bool}{HasGripper}{\void} + + +\membersection{wxPaneInfo::HasGripperTop}\label{wxpaneinfohasgrippertop} + +\constfunc{bool}{HasGripperTop}{\void} + + +\membersection{wxPaneInfo::HasMaximizeButton}\label{wxpaneinfohasmaximizebutton} + +\constfunc{bool}{HasMaximizeButton}{\void} + + +\membersection{wxPaneInfo::HasMinimizeButton}\label{wxpaneinfohasminimizebutton} + +\constfunc{bool}{HasMinimizeButton}{\void} + + +\membersection{wxPaneInfo::HasPinButton}\label{wxpaneinfohaspinbutton} + +\constfunc{bool}{HasPinButton}{\void} + + +\membersection{wxPaneInfo::Hide}\label{wxpaneinfohide} + +\func{wxPaneInfo\&}{Hide}{\void} + + +\membersection{wxPaneInfo::IsBottomDockable}\label{wxpaneinfoisbottomdockable} + +\constfunc{bool}{IsBottomDockable}{\void} + + +\membersection{wxPaneInfo::IsDocked}\label{wxpaneinfoisdocked} + +\constfunc{bool}{IsDocked}{\void} + + +\membersection{wxPaneInfo::IsFixed}\label{wxpaneinfoisfixed} + +\constfunc{bool}{IsFixed}{\void} + + +\membersection{wxPaneInfo::IsFloatable}\label{wxpaneinfoisfloatable} + +\constfunc{bool}{IsFloatable}{\void} + + +\membersection{wxPaneInfo::IsFloating}\label{wxpaneinfoisfloating} + +\constfunc{bool}{IsFloating}{\void} + + +\membersection{wxPaneInfo::IsLeftDockable}\label{wxpaneinfoisleftdockable} + +\constfunc{bool}{IsLeftDockable}{\void} + + +\membersection{wxPaneInfo::IsMovable}\label{wxpaneinfoismovable} + +\constfunc{bool}{IsMovable}{\void} + + +\membersection{wxPaneInfo::IsOk}\label{wxpaneinfoisok} + +\constfunc{bool}{IsOk}{\void} + + +\membersection{wxPaneInfo::IsResizable}\label{wxpaneinfoisresizable} + +\constfunc{bool}{IsResizable}{\void} + + +\membersection{wxPaneInfo::IsRightDockable}\label{wxpaneinfoisrightdockable} + +\constfunc{bool}{IsRightDockable}{\void} + + +\membersection{wxPaneInfo::IsShown}\label{wxpaneinfoisshown} + +\constfunc{bool}{IsShown}{\void} + + +\membersection{wxPaneInfo::IsToolbar}\label{wxpaneinfoistoolbar} + +\constfunc{bool}{IsToolbar}{\void} + + +\membersection{wxPaneInfo::IsTopDockable}\label{wxpaneinfoistopdockable} + +\constfunc{bool}{IsTopDockable}{\void} + + +\membersection{wxPaneInfo::Layer}\label{wxpaneinfolayer} + +\func{wxPaneInfo\&}{Layer}{\param{int }{layer}} + + +\membersection{wxPaneInfo::Left}\label{wxpaneinfoleft} + +\func{wxPaneInfo\&}{Left}{\void} + + +\membersection{wxPaneInfo::LeftDockable}\label{wxpaneinfoleftdockable} + +\func{wxPaneInfo\&}{LeftDockable}{\param{bool }{b = true}} + + +\membersection{wxPaneInfo::MaxSize}\label{wxpaneinfomaxsize} + +\func{wxPaneInfo\&}{MaxSize}{\param{const wxSize\& }{size}} + + +\func{wxPaneInfo\&}{MaxSize}{\param{int }{x}, \param{int }{y}} + + +\membersection{wxPaneInfo::MaximizeButton}\label{wxpaneinfomaximizebutton} + +\func{wxPaneInfo\&}{MaximizeButton}{\param{bool }{visible = true}} + + +\membersection{wxPaneInfo::MinSize}\label{wxpaneinfominsize} + +\func{wxPaneInfo\&}{MinSize}{\param{const wxSize\& }{size}} + + +\func{wxPaneInfo\&}{MinSize}{\param{int }{x}, \param{int }{y}} + + +\membersection{wxPaneInfo::MinimizeButton}\label{wxpaneinfominimizebutton} + +\func{wxPaneInfo\&}{MinimizeButton}{\param{bool }{visible = true}} + + +\membersection{wxPaneInfo::Movable}\label{wxpaneinfomovable} + +\func{wxPaneInfo\&}{Movable}{\param{bool }{b = true}} + + +\membersection{wxPaneInfo::Name}\label{wxpaneinfoname} + +\func{wxPaneInfo\&}{Name}{\param{const wxString\& }{n}} + + +\membersection{wxPaneInfo::PaneBorder}\label{wxpaneinfopaneborder} + +\func{wxPaneInfo\&}{PaneBorder}{\param{bool }{visible = true}} + + +\membersection{wxPaneInfo::PinButton}\label{wxpaneinfopinbutton} + +\func{wxPaneInfo\&}{PinButton}{\param{bool }{visible = true}} + + +\membersection{wxPaneInfo::Position}\label{wxpaneinfoposition} + +\func{wxPaneInfo\&}{Position}{\param{int }{pos}} + + +\membersection{wxPaneInfo::Resizable}\label{wxpaneinforesizable} + +\func{wxPaneInfo\&}{Resizable}{\param{bool }{resizable = true}} + + +\membersection{wxPaneInfo::Right}\label{wxpaneinforight} + +\func{wxPaneInfo\&}{Right}{\void} + + +\membersection{wxPaneInfo::RightDockable}\label{wxpaneinforightdockable} + +\func{wxPaneInfo\&}{RightDockable}{\param{bool }{b = true}} + + +\membersection{wxPaneInfo::Row}\label{wxpaneinforow} + +\func{wxPaneInfo\&}{Row}{\param{int }{row}} + + +\membersection{wxPaneInfo::SafeSet}\label{wxpaneinfosafeset} + +\func{void}{SafeSet}{\param{wxPaneInfo }{source}} + +Write the safe parts of a newly loaded PaneInfo structure "source" into "this" +used on loading perspectives etc. + + +\membersection{wxPaneInfo::SetFlag}\label{wxpaneinfosetflag} + +\func{wxPaneInfo\&}{SetFlag}{\param{unsigned int }{flag}, \param{bool }{option\_state}} + + +\membersection{wxPaneInfo::Show}\label{wxpaneinfoshow} + +\func{wxPaneInfo\&}{Show}{\param{bool }{show = true}} + + +\membersection{wxPaneInfo::ToolbarPane}\label{wxpaneinfotoolbarpane} + +\func{wxPaneInfo\&}{ToolbarPane}{\void} + + +\membersection{wxPaneInfo::Top}\label{wxpaneinfotop} + +\func{wxPaneInfo\&}{Top}{\void} + + +\membersection{wxPaneInfo::TopDockable}\label{wxpaneinfotopdockable} + +\func{wxPaneInfo\&}{TopDockable}{\param{bool }{b = true}} + + +\membersection{wxPaneInfo::Window}\label{wxpaneinfowindow} + +\func{wxPaneInfo\&}{Window}{\param{wxWindow* }{w}} + + +\membersection{wxPaneInfo::operator=}\label{wxpaneinfooperatorassign} + +\func{wxPaneInfo\& operator}{operator=}{\param{const wxPaneInfo\& }{c}} + diff --git a/docs/latex/wx/taui.tex b/docs/latex/wx/taui.tex new file mode 100644 index 0000000000..de623734f0 --- /dev/null +++ b/docs/latex/wx/taui.tex @@ -0,0 +1,45 @@ +\section{wxAUI overview}\label{wxauioverview} + +Class: \helpref{wxFraneManager}{wxframemanager}, \helpref{wxPaneInfo}{wxpaneinfo} + +wxAUI stands for Advances User Interface and the wxAUI framework +aims to give its user a cutting edge interface for use with the +wxWidgets based applications. The original wxAUI sources have +kindly been made available under the wxWindows licence +by Kirix Corp. and they have since then been integrated into +wxWidgets CVS and further improved. + +wxAUI attempts to encapsulate the following aspects of the user interface: + +{\bf Frame Management:} +Frame management provides the means to open, move and hide common +controls that are needed to interact with the document, and allow these +configurations to be saved into different perspectives and loaded at a +later time. + +{\bf Toolbars:} +Toolbars are a specialized subset of the frame management system and +should behave similarly to other docked components. However, they also +require additional functionality, such as "spring-loaded" rebar support, +"chevron" buttons and end-user customizability. + +{\bf Modeless Controls:} +Modeless controls expose a tool pallete or set of options that float +above the application content while allowing it to be accessed. Usually +accessed by the toolbar, these controls disappear when an option is +selected, but may also be "torn off" the toolbar into a floating frame +of their own. + +{\bf Look and Feel:} +Look and feel encompasses the way controls are drawn, both when shown +statically as well as when they are being moved. This aspect of user +interface design incorporates "special effects" such as transparent +window dragging as well as frame animation. + +wxAUI adheres to the following principles: + +Use native floating frames to obtain a native look and feel for all +platforms. Use existing wxWidgets code where possible, such as sizer +implementation for frame management. Use classes included in wxCore +and wxBase only. Use standard wxWidgets coding conventions. + diff --git a/docs/latex/wx/topics.tex b/docs/latex/wx/topics.tex index 624e734dba..0454e8c496 100644 --- a/docs/latex/wx/topics.tex +++ b/docs/latex/wx/topics.tex @@ -60,6 +60,7 @@ This chapter contains a selection of topic overviews. \input tipc.tex \input wxhtml.tex \input richtextoverview.tex +\input taui.tex \input tenvvars.tex \input wxPython.tex \input re_syntax.tex -- 2.45.2