added missing \wxheading{Parameters}

[wxWidgets.git] / docs / latex / wx / pickerbase.tex

diff --git a/docs/latex/wx/pickerbase.tex b/docs/latex/wx/pickerbase.tex
index 07f12bb15c4067714f9dfab9f30179a3880c369d..94d78e7bbbbcba2d0dc0094608e3af79e14edcb5 100644 (file)
--- a/docs/latex/wx/pickerbase.tex
+++ b/docs/latex/wx/pickerbase.tex
@@ -13,7 +13,10 @@
 Base abstract class for all pickers which support an auxiliary text control.
 This class handles all positioning and sizing of the text control like a
 an horizontal \helpref{wxBoxSizer}{wxboxsizer} would do, with the text control on
 Base abstract class for all pickers which support an auxiliary text control.
 This class handles all positioning and sizing of the text control like a
 an horizontal \helpref{wxBoxSizer}{wxboxsizer} would do, with the text control on

-the left of the picker button and the proportion of the picker fixed to value 1.
+the left of the picker button.
+The proportion (see \helpref{wxSizer}{wxsizer} documentation for more info about
+proportion values) of the picker control defaults to $1$ when there isn't a text control
+associated (see {\tt wxPB\_USE\_TEXTCTRL} style) and to $0$ otherwise.

 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 


@@ -26,6 +29,10 @@ the left of the picker button and the proportion of the picker fixed to value 1.
 
 <wx/pickerbase.h>
 
 
 <wx/pickerbase.h>
 

+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+

 \wxheading{Window styles}
 
 \twocolwidtha{5cm}%
 \wxheading{Window styles}
 
 \twocolwidtha{5cm}%


@@ -47,7 +54,7 @@ class.}
 \func{void}{SetInternalMargin}{\param{int}{margin}}
 
 Sets the margin (in pixel) between the picker and the text control.
 \func{void}{SetInternalMargin}{\param{int}{margin}}
 
 Sets the margin (in pixel) between the picker and the text control.

-This function can be used only when \helpref{wxpickerbasehastextctrl}{HasTextCtrl} returns \true.
+This function can be used only when \helpref{HasTextCtrl}{wxpickerbasehastextctrl} returns \true.

 
 
 \membersection{wxPickerBase::GetInternalMargin}\label{wxpickerbasegetinternalmargin}
 
 
 \membersection{wxPickerBase::GetInternalMargin}\label{wxpickerbasegetinternalmargin}


@@ -55,25 +62,39 @@ This function can be used only when \helpref{wxpickerbasehastextctrl}{HasTextCtr
 \constfunc{int}{GetInternalMargin}{}
 
 Returns the margin (in pixel) between the picker and the text control.
 \constfunc{int}{GetInternalMargin}{}
 
 Returns the margin (in pixel) between the picker and the text control.

-This function can be used only when \helpref{wxpickerbasehastextctrl}{HasTextCtrl} returns \true.
+This function can be used only when \helpref{HasTextCtrl}{wxpickerbasehastextctrl} returns \true.

 
 
 \membersection{wxPickerBase::SetTextCtrlProportion}\label{wxpickerbasesettextctrlproportion}
 
 \func{void}{SetTextCtrlProportion}{\param{int}{prop}}
 
 
 
 \membersection{wxPickerBase::SetTextCtrlProportion}\label{wxpickerbasesettextctrlproportion}
 
 \func{void}{SetTextCtrlProportion}{\param{int}{prop}}
 

-Sets the proportion between the text control and the picker.
+Sets the proportion value of the text control.
+Look at the overview of wxPickerBase for more details about this.
+This function can be used only when \helpref{HasTextCtrl}{wxpickerbasehastextctrl} returns \true.
+
+
+\membersection{wxPickerBase::SetPickerCtrlProportion}\label{wxpickerbasesetpickerctrlproportion}
+
+\func{void}{SetPickerCtrlProportion}{\param{int}{prop}}
+
+Sets the proportion value of the picker.

 Look at the overview of wxPickerBase for more details about this.
 Look at the overview of wxPickerBase for more details about this.

-This function can be used only when \helpref{wxpickerbasehastextctrl}{HasTextCtrl} returns \true.

 
 
 \membersection{wxPickerBase::GetTextCtrlProportion}\label{wxpickerbasegettextctrlproportion}
 
 \constfunc{int}{GetTextCtrlProportion}{}
 
 
 
 \membersection{wxPickerBase::GetTextCtrlProportion}\label{wxpickerbasegettextctrlproportion}
 
 \constfunc{int}{GetTextCtrlProportion}{}
 

-Returns the proportion between the text control and the picker.
-This function can be used only when \helpref{wxpickerbasehastextctrl}{HasTextCtrl} returns \true.
+Returns the proportion value of the text control.
+This function can be used only when \helpref{HasTextCtrl}{wxpickerbasehastextctrl} returns \true.
+
+
+\membersection{wxPickerBase::GetPickerCtrlProportion}\label{wxpickerbasegetpickerctrlproportion}

 
 

+\constfunc{int}{GetPickerCtrlProportion}{}
+
+Returns the proportion value of the picker.

 
 
 \membersection{wxPickerBase::HasTextCtrl}\label{wxpickerbasehastextctrl}
 
 
 \membersection{wxPickerBase::HasTextCtrl}\label{wxpickerbasehastextctrl}


@@ -97,7 +118,14 @@ Very important: the contents of the text control could be containing an invalid
 \constfunc{bool}{IsTextCtrlGrowable}{}
 
 Returns \true if the text control is growable.
 \constfunc{bool}{IsTextCtrlGrowable}{}
 
 Returns \true if the text control is growable.

-This function can be used only when \helpref{wxpickerbasehastextctrl}{HasTextCtrl} returns \true.
+This function can be used only when \helpref{HasTextCtrl}{wxpickerbasehastextctrl} returns \true.
+
+
+\membersection{wxPickerBase::SetPickerCtrlGrowable}\label{wxpickerbasesetpickerctrlgrowable}
+
+\func{void}{SetPickerCtrlGrowable}{\param{bool}{ grow = true}}
+
+Sets the picker control as growable when {\tt grow} is \true.

 
 
 \membersection{wxPickerBase::SetTextCtrlGrowable}\label{wxpickerbasesettextctrlgrowable}
 
 
 \membersection{wxPickerBase::SetTextCtrlGrowable}\label{wxpickerbasesettextctrlgrowable}


@@ -105,7 +133,7 @@ This function can be used only when \helpref{wxpickerbasehastextctrl}{HasTextCtr
 \func{void}{SetTextCtrlGrowable}{\param{bool}{ grow = true}}
 
 Sets the text control as growable when {\tt grow} is \true.
 \func{void}{SetTextCtrlGrowable}{\param{bool}{ grow = true}}
 
 Sets the text control as growable when {\tt grow} is \true.

-This function can be used only when \helpref{wxpickerbasehastextctrl}{HasTextCtrl} returns \true.
+This function can be used only when \helpref{HasTextCtrl}{wxpickerbasehastextctrl} returns \true.

 
 
 
 
 
 


@@ -121,5 +149,5 @@ Returns \true if the picker control is growable.
 \func{void}{SetPickerCtrlGrowable}{\param{bool}{ grow = true}}
 
 Sets the picker control as growable when {\tt grow} is \true.
 \func{void}{SetPickerCtrlGrowable}{\param{bool}{ grow = true}}
 
 Sets the picker control as growable when {\tt grow} is \true.

-This function has effects only when \helpref{wxpickerbasehastextctrl}{HasTextCtrl} returns \true.
+This function has effects only when \helpref{HasTextCtrl}{wxpickerbasehastextctrl} returns \true.