\twocolitem{\helpref{wxSizer}{wxsizer}}{Abstract base class}
\twocolitem{\helpref{wxBoxSizer}{wxboxsizer}}{A sizer for laying out windows in a row or column}
\twocolitem{\helpref{wxStaticBoxSizer}{wxstaticboxsizer}}{Same as wxBoxSizer, but with surrounding static box}
+\twocolitem{\helpref{wxNotebookSizer}{wxnotebooksizer}}{Sizer to use with the wxNotebook control.}
\end{twocollist}
\overview{Overview}{constraintsoverview} over the constraints-based layout.
\input mltchdlg.tex
\input mutex.tex
\input mutexlck.tex
+\input nbsizer.tex
\input node.tex
\input notebook.tex
\input noteevt.tex
wxDIR_DOTDOT = 0x0008, // include '.' and '..'
// by default, enumerate everything except '.' and '..'
- wxDIR_DEFAULT = wxDIR\_FILES | wxDIR\_DIRS | wxDIR\_HIDDEN
+ wxDIR_DEFAULT = wxDIR_FILES | wxDIR_DIRS | wxDIR_HIDDEN
}
\end{verbatim}
}
\section{\class{wxFilterInputStream}}\label{wxfilterinputstream}
A filter stream has the capability of a normal stream but it can be placed on top
-of another stream. So, for example, it can uncompress, uncrypt the datas which are read
+of another stream. So, for example, it can uncompress or uncrypt the data which are read
from another stream and pass it to the requester.
\wxheading{Derived from}
\wxheading{Note}
-The use of this class is exactly the same as of wxInputStream. Only a constructor
+The interface of this class is the same as that of wxInputStream. Only a constructor
differs and it is documented below.
% -----------
\wxheading{See also}
-\helpref{wxPathList}{wxpathlist}
+\helpref{wxPathList}{wxpathlist}, \helpref{wxDir}{wxdir}, \helpref{wxFile}{wxfile}
\membersection{::wxDirExists}
\membersection{::wxGetHostName}\label{wxgethostname}
\func{wxString}{wxGetHostName}{\void}
+
\func{bool}{wxGetHostName}{\param{char * }{buf}, \param{int }{sz}}
Copies the current host machine's name into the supplied buffer. Please note
\membersection{::wxGetUserId}\label{wxgetuserid}
\func{wxString}{wxGetUserId}{\void}
+
\func{bool}{wxGetUserId}{\param{char * }{buf}, \param{int }{sz}}
This function returns the "user id" also known as "login name" under Unix i.e.
\membersection{::wxGetUserName}\label{wxgetusername}
\func{wxString}{wxGetUserName}{\void}
+
\func{bool}{wxGetUserName}{\param{char * }{buf}, \param{int }{sz}}
This function returns the full user name (something like "Mr. John Smith").
\section{Clipboard functions}\label{clipsboard}
These clipboard functions are implemented for Windows only. The use of these functions
-is drepated and the code no longer maintained. Use the \helpref{wxClipboard}{wxclipboard}
+is deprecated and the code is no longer maintained. Use the \helpref{wxClipboard}{wxclipboard}
class instead.
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxGetHostName}
-
-\func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
-
-Copies the host name of the machine the program is running on into the
-buffer {\it buf}, of maximum size {\it bufSize}, returning TRUE if
-successful.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
\membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
\func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
--- /dev/null
+\section{\class{wxNotebookSizer}}\label{wxnotebooksizer}
+
+wxNotebookSizer is a specialized sizer to make sizers work in connection
+with using notebooks. This sizer is different from any other sizer as
+you must not add any children to it - instead, it queries the notebook class itself.
+The only thing this sizer does is to determine the size of the biggest
+page of the notebook and report an adjusted minimal size to a more toplevel
+sizer.
+
+In order to query the size of notebook page, this page needs to have its
+own sizer, otherwise the wxNotebookSizer will ignore it. Notebook pages
+get there sizer by assiging one to them using \helpref{wxWindow::SetSizer}{wxwindowsetsizer}
+and setting the auto-layout option to TRUE using
+\helpref{wxWindow::SetAutolayout}{wxwindowsetautoLayout}. Here is one
+example showing how to add a notebook page that the notebook sizer is
+aware of:
+
+\begin{verbatim}
+ wxNotebook *notebook = new wxNotebook( &dialog, -1 );
+ wxNotebookSizer *nbs = new wxNotebookSizer( notebook );
+
+ // Add panel as notebook page
+ wxPanel *panel = new wxPanel( notebook, -1 );
+ notebook->AddPage( panel, "My Notebook Page" );
+
+ wxBoxSizer *panelsizer = new wxBoxSizer( wxVERTICAL );
+
+ // Add controls to panel and panelsizer here...
+
+ panel->SetAutoLayout( TRUE );
+ panel->SetSizer( panelsizer );
+\end{verbatim}
+
+See also \helpref{wxSizer}{wxsizer}, \helpref{wxNotebook}{wxnotebook}.
+
+\wxheading{Derived from}
+
+\helpref{wxSizer}{wxsizer}\\
+\helpref{wxObject}{wxobject}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxNotebookSizer::wxNotebookSizer}\label{wxnotebooksizerwxnotebooksizer}
+
+\func{}{wxNotebookSizer}{\param{wxNotebook* }{notebook}}
+
+Constructor. It takes an associated notebook as its only parameter.
+
+\membersection{wxNotebookSizer::GetNotebook}\label{wxnotebooksizergetnotebook}
+
+\func{wxNotebook*}{GetNotebook}{\void}
+
+Returns the notebook associated with the sizer.
+
\section{\class{wxSizer}}\label{wxsizer}
wxSizer is the abstract base class used for laying out subwindows in a window. You
-cannot use wxSizer directly; instead, you'll have to use \helpref{wxBoxSizer}{wxboxsizer}
-or \helpref{wxStaticBoxSizer}{wxstaticboxsizer}.
+cannot use wxSizer directly; instead, you'll have to use \helpref{wxBoxSizer}{wxboxsizer},
+\helpref{wxStaticBoxSizer}{wxstaticboxsizer} or \helpref{wxNotebookSizer}{wxnotebooksizer}.
The layout algorithm used by sizers in wxWindows is closely related to layout
in other GUI toolkits, such as Java's AWT, the GTK toolkit or the Qt toolkit. It is
When you use this function, you'll have to destroy the IO buffers yourself
after the stream buffer is destroyed or don't use it anymore.
-In the case you use it with an empty buffer, the stream buffer will not grow
+In the case you use it with an empty buffer, the stream buffer will not resize
it when it is full.
\wxheading{See also}
\wxheading{See also}
-\helpref{wxStreamBuffer}{wxstreambuffer}, \helpref{wxInputStream}{wxinputstream}
+\helpref{wxStreamBuffer}{wxstreambuffer}, \helpref{wxInputStream}{wxinputstream},
+\helpref{wxBufferedOutputStream}{wxbufferedoutputstream}
% -----------------------------------------------------------------------------
% wxBufferedOutputStream
This stream acts as a cache. It caches the bytes to be written to the specified
output stream (See \helpref{wxFilterOutputStream}{wxfilteroutputstream}). The
-datas are only written when the cache is full, when the buffered stream is
+data is only written when the cache is full, when the buffered stream is
destroyed or when calling SeekO().
This class may not be used without some other stream to write the data
\wxheading{See also}
-\helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxOutputStream}{wxoutputstream}
+\helpref{wxStreamBuffer}{wxstreambuffer}, \helpref{wxOutputStream}{wxoutputstream}
% ----------
% Members
\wxheading{See also}
-\helpref{wxStreamBuffer}{wxstreambuffer}
+\helpref{wxStreamBuffer}{wxstreambuffer}, \helpref{wxMemoryOutputStream}{wxmemoutputstream}
% ----------
% Members
Initializes a new read-only memory stream which will use the specified buffer
{\it data} of length {\it len}. The stream does not take ownership of the
-buffer, i.e. that it will not delete in its constructor.
+buffer, i.e. that it will not delete in its destructor.
\membersection{wxMemoryInputStream::\destruct{wxMemoryInputStream}}
-\func{}{\destruct{wxFileInputStream}}{\void}
+\func{}{\destruct{wxMemoryInputStream}}{\void}
Destructor.
as setting the cursor in a parent window also effects the
windows above so that checking for the current cursor is
not possible. */
-
- if (HasFlag(wxTB_DOCKABLE))
+
+ if (HasFlag(wxTB_DOCKABLE) && (m_widget->window))
{
/* if the toolbar is dockable, then m_widget stands for the
GtkHandleBox widget, which uses its own window so that we
as setting the cursor in a parent window also effects the
windows above so that checking for the current cursor is
not possible. */
-
- if (HasFlag(wxTB_DOCKABLE))
+
+ if (HasFlag(wxTB_DOCKABLE) && (m_widget->window))
{
/* if the toolbar is dockable, then m_widget stands for the
GtkHandleBox widget, which uses its own window so that we
projects / wxWidgets.git / commitdiff
